simGetScriptStringParam

Retrieves a string parameter of a script

C++ synopsis

char* simGetScriptStringParam(int scriptHandle, int parameterID, int* parameterLength)

Arguments

  • scriptHandle: handle of the script
  • parameterID: identifier of the parameter to retrieve. See the list of all possible script parameters
  • parameterLength: the length of the retrieved parameter

Return

  • 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.


See also: