|
Description
|
Reads custom data that is stored inside of an object or the scene. Reads also custom data for the application's currrent session. See also the other custom data block related functions and the data packing/unpacking functions. |
C/C++
synopsis
|
simChar* simReadCustomDataBlock(simInt objectHandle,const simChar* tagName,simInt* dataSize)
|
C/C++
parameters |
objectHandle: handle of the object, 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.
tagName: a string that identifies the data.
dataSize: a pointer to an integer receiving the size of the returned buffer.
|
C/C++
return value
|
the custom data block, or nil in case of an error (or if the data is not present). The user is in charge of releasing the returned buffer with simReleaseBuffer.
|
Lua
synopsis
|
buffer customDataBlock=sim.readCustomDataBlock(int objectHandle,string tagName) |
Lua
parameters |
Similar to the C-function counterpart.
|
Lua
return values
|
Similar to the C-function counterpart.
|
Python
synopsis |
string/bytes customDataBlock=sim.readCustomDataBlock(int objectHandle,string tagName) |
