Regular API function

simGetNamedStringParam / sim.getNamedStringParam

Description Retrieves a named string or buffer parameter. See also the other simulator named parameter related functions.
C/C++
synopsis
simChar* simGetNamedStringParam(const simChar* paramName,simInt* paramLength)
C/C++
parameters
paramName: the key or name of the parameter
paramLength: the size of the parameter
C/C++
return value
nullptr 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
buffer stringParam=sim.getNamedStringParam(string paramName)
Lua
parameters
Similar to the C-function counterpart
Lua
return values
Similar to the C-function counterpart
Python
synopsis
bytes stringParam=sim.getNamedStringParam(string paramName)