Regular API
function
simGetStringNamedParam / sim.getStringNamedParam
Description
Retrieves a named string or buffer value. See also
sim.setStringNamedParam
.
C synopsis
simChar* simGetStringNamedParam(const simChar* paramName,simInt* paramLength)
C parameters
paramName
: the key or name of the parameter
paramLength
: the size of the parameter
C return value
NULL if operation was not successful or if such a parameter does not exist. Otherwise the parameter. The user is in charge of releasing the returned buffer with
simReleaseBuffer
.
Lua synopsis
string stringParam=sim.getStringNamedParam(string paramName)
Lua parameters
Same as C-function
Lua return values
Same as C-function
All regular API functions on one page