Regular API function

simGetObjectHandle (remote API equivalent: simxGetObjectHandle)

Description Retrieves an object handle based on its name. The operation of this function depends on the current name suffix settings (see simGetNameSuffix, simSetNameSuffix, and the section on accessing general-type objects). See also simIsHandleValid and simGetObjectUniqueIdentifier.
C synopsis simInt simGetObjectHandle(const simChar* objectName)
C parameters
objectName: name of object
C return value
handle of object or -1 if operation was not successful
Lua synopsis number objectHandle=simGetObjectHandle(string objectName)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page