Regular API function

simGetStringSignal / sim.getStringSignal

Description Gets the value of a string signal. See also the other signal functions.
C/C++
synopsis
simChar* simGetStringSignal(const simChar* signalName,simInt* stringLength)
C/C++
parameters
signalName: name of the signal
stringLength: the size of the returned string, since it may contain any data (also embedded zeros).
C/C++
return value
nullptr if operation was not successful or signal does not exist, otherwise the value of the string signal (which may contain any value, including embedded zeros). In that case the returned buffer should be released with simReleaseBuffer
Lua
synopsis
buffer signalValue=sim.getStringSignal(string signalName)
Lua
parameters
signalName: name of the signal
Lua
return values
signalValue: value of the signal, or nil if signal does not exist. The returned signal may contain any value, including embedded zeros.
Python
synopsis
string/bytes signalValue=sim.getStringSignal(string signalName)