|
Description
|
Retrieves a string parameter of a script. See also the other functions related to script parameters.
|
C/C++
synopsis
|
simChar* simGetScriptStringParam(simInt scriptHandle,simInt parameterID,simInt* parameterLength)
|
C/C++
parameters |
scriptHandle: handle of the script
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.getScriptStringParam(int scriptHandle,int parameterID)
|
Lua
parameters |
Similar to the C-function counterpart. Additionally, sim.handle_self may be used for scriptHandle.
|
Lua
return values
|
Similar to the C-function counterpart
|
Python
synopsis |
string/bytes parameter=sim.getScriptStringParam(int scriptHandle,int parameterID) |
