Regular API function

simGetReferencedHandles / sim.getReferencedHandles

Description Retrieves a list of custom handles, linking a given scene object to other scene objects. See also sim.setReferencedHandles.
C/C++
synopsis
simInt simGetReferencedHandles(simInt objectHandle,simInt** referencedHandles,simInt** reserved1,simInt** reserved2)
C/C++
parameters
objectHandle: handle of the scene object that stores the list of handles. Can be optionally combined with sim.handleflag_keeporiginal, in which case the handles that link to originals are retrieved.
referencedHandles: a pointer to a pointer that will be allocated and receive the list of scene object handles. The user is in charge of releasing that buffer with simReleaseBuffer.
reserved1: reserved for future extensions
reserved2: reserved for future extensions
C/C++
return value
-1 in case of an error. Otherwise, the number of handles returned.
Lua
synopsis
int[] referencedHandles=sim.getReferencedHandles(int objectHandle)
Lua
parameters
Similar to the C-function
Lua
return values
Similar to the C-function
Python
synopsis
list referencedHandles=sim.getReferencedHandles(int objectHandle)