Regular API function

simReadCustomDataBlockTags / sim.readCustomDataBlockTags

Description Reads the tags of all custom data that is stored inside of an object, a script or a scene (i.e. the data is part of the object, the script or the scene). Reads also all custom data that is stored inside of the application's current session. See also sim.readCustomDataBlock.
C synopsis simChar* simReadCustomDataBlockTags(simInt objectHandle,simInt* tagCount)
C parameters
objectHandle: handle of the object or script where the data is stored, or sim_handle_scene if the data is stored in the scene, or sim_handle_app if the data is stored in the application's current session.
tagCount: a pointer to an integer receiving the number of tag strings contained in the returned buffer.
C return value
the tags (each followed by the zero-char) or nil in case of an error (or if no tags are present). The user is in charge of releasing the returned buffer with simReleaseBuffer.
Lua synopsis table tags=sim.readCustomDataBlockTags(number objectHandle)
Lua parameters
Same as C-function. In addition, you can specify sim.handle_self for the objectHandle argument, if your target is the current script.
Lua return values
Similar to C-function.

All regular API functions on one page