Regular API function

simGetObjectStringParam / sim.getObjectStringParam

Description Retrieves a string parameter of a scene object. See also the other object parameter related functions
C/C++
synopsis
simChar* simGetObjectStringParam(simInt objectHandle,simInt parameterID,simInt* parameterLength)
C/C++
parameters
objectHandle: handle of the object
parameterID: identifier of the parameter to retrieve. See the list of all possible object parameters
parameterLength: the length of the retrieved parameter
C/C++
return value
A buffer containing the retrieved string, or nullptr in case of an error. The user is in charge of releasing the returned buffer with simReleaseBuffer. The returned buffer might contain embedded zeros, and its length is specified by the parameterLength argument.
Lua synopsis buffer parameter=sim.getObjectStringParam(int objectHandle,int parameterID)
Lua parameters
Similar to the C-function counterpart
Lua return values
Similar to the C-function counterpart
Python synopsis string/bytes parameter=sim.getObjectStringParam(int objectHandle,int parameterID)