Regular API function

simGetObjectInt32Parameter
remote API equivalent: simxGetObjectIntParameter
RosPlugin API equivalent: simRosGetObjectIntParameter

Description Retrieves an int32 parameter of a scene object or calculation object. See also simSetObjectInt32Parameter, simGetObjectFloatParameter and simGetObjectStringParameter
C synopsis simInt simGetObjectInt32Parameter(simInt objectHandle,simInt parameterID,simInt* parameter)
C parameters
objectHandle: handle of the object
parameterID: identifier of the parameter to retrieve. See the list of all possible object parameter identifiers
parameter: retrieved parameter
C return value
-1 in case of an error, 0 if the parameter could not be retrieved (e.g. because the parameterID doesn't exist, or because the specified object doesn't correspond to the correct type), or 1 if the operation was successful
Lua synopsis number result,number parameter=simGetObjectInt32Parameter(number objectHandle,number parameterID)
Lua parameters
Same as C-function
Lua return values
result: -1 in case of an error, 0 if the parameter could not be retrieved (e.g. because the parameterID doesn't exist, or because the specified object doesn't correspond to the correct type), or 1 if the operation was successful
parameter: retrieved parameter. See also the boolean operators in Lua.

All regular API functions on one page