Regular API function


Description Retrieves the scene custom data previously added with the simAddSceneCustomData function. See also simGetSceneCustomDataLength, simAddSceneCustomData, simReadCustomDataBlock and simPersistentDataRead.
C synopsis simInt simGetSceneCustomData(simInt header,simChar* data)
C parameters
header: identifier of the custom data. See simAddSceneCustomData for details.
data: pointer to a data buffer allocated by the user. Use simGetSceneCustomDataLength to adjust the buffer size.
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis string data=simGetSceneCustomData(number header)
Lua parameters
Same as C-function.
Lua return values
nil if operation was not successful. Otherwise the custom data (might be an empty string if custom data doesn't exist).

All regular API functions on one page