Regular API function

simSetObjectStringParameter / sim.setObjectStringParameter

Description Sets a string parameter of a scene object or calculation object. See also sim.getObjectStringParameter, sim.setObjectInt32Parameter and sim.setObjectFloatParameter
C synopsis simInt simSetObjectStringParameter(simInt objectHandle,simInt parameterID,simChar* parameter,simInt parameterLength)
C parameters
objectHandle: handle of the object
parameterID: identifier of the parameter to retrieve. See the list of all possible object parameter identifiers
parameter: parameter value (can contain embedded zeros)
parameterLength: the length of the parameter value
C return value
-1 in case of an error, 0 if the parameter could not be set (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=sim.setObjectStringParameter(number objectHandle,number parameterID,string parameter)
Lua parameters
Same as C-function
Lua return values Same as C-function
Remote API equiv.
B0-based remote API: simxSetObjectStringParameter
Legacy remote API: -

All regular API functions on one page