Regular API function

simGetArrayParameter / sim.getArrayParameter

Description Retrieves 3 values from an array. See the array parameter identifiers. See also sim.setArrayParameter, sim.getBoolParameter, sim.getInt32Parameter, sim.getFloatParameter and sim.getStringParameter.
C synopsis simInt simGetArrayParameter(simInt parameter,simVoid* parameterValues)
C parameters
parameterValues: a simFloat pointer (simVoid is kept for backward compatibility). The 3 values will be copied to that location
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis table parameterValues=sim.getArrayParameter(number parameter)
Lua parameters
Same as C-function
Lua return values
parameterValues: a table that holds the returned values, or nil in case of an error
Remote API equiv.
B0-based remote API: simxGetArrayParameter
Legacy remote API: simxGetArrayParameter

All regular API functions on one page