Regular API
function
simGetStringParameter / sim.getStringParameter
Description
Retrieves a string value. See the
string parameter identifiers
. See also
sim.getBoolParameter
,
sim.getInt32Parameter
,
sim.getArrayParameter
and
sim.getFloatParameter
.
C synopsis
simChar* simGetStringParameter(simInt parameter)
C parameters
parameter
:
string parameter identifier
C return value
NULL if operation was not successful. Otherwise the string parameter. The user is in charge of releasing the returned buffer with
simReleaseBuffer
.
Lua synopsis
string parameterValue=sim.getStringParameter(number parameter)
Lua parameters
Same as C-function
Lua return values
Same as C-function
Remote API equiv.
B0-based remote API:
simxGetStringParameter
Legacy remote API:
simxGetStringParameter
All regular API functions on one page