Regular API function

simGetStringSignal (remote API equivalent: simxGetStringSignal)

Description Gets the value of a string signal. Signals are cleared at simulation start. See also simSetStringSignal, the other signal functions, the data packing/unpacking functions and simPersistentDataRead.
C synopsis simChar* simGetStringSignal(const simChar* signalName,simInt* stringLength)
C parameters
signalName: name of the signal
stringLength: the size of the returned string, since it may contain any data (also embedded zeros).
C return value
NULL 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 string signalValue=simGetStringSignal(string signalName)
Lua parameters
signalName: name of the signal
Lua return values
signalValue: value of the signal, or nil if operation was not successful or signal does not exist. The returned signal may contain any value, including embedded zeros.

All regular API functions on one page