Regular API function


Description Retrieves a string parameter of a scene object or calculation object. See also simSetObjectStringParameter, simGetObjectInt32Parameter and simGetObjectFloatParameter
C synopsis simChar* simGetObjectStringParameter(simInt objectHandle,simInt parameterID,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
parameterLength: the length of the retrieved parameter
C return value
A buffer containing the retrieved string, or NULL 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 string parameter=simGetObjectStringParameter(number objectHandle,number parameterID)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page