Regular API function

simGetMechanismHandle / sim.getMechanismHandle

Description Retrieves the handle of a mechanism to be solved by the geometric constraint solver. The operation of this function depends on the current name suffix settings (see sim.getNameSuffix, sim.setNameSuffix, and the section on accessing general-type objects). See also sim.isHandleValid.
C synopsis simInt simGetMechanismHandle(const simChar* mechanismName)
C parameters
mechanismName: name of the mechanism
C return value
Handle of the mechanism if operation was successful, -1 otherwise
Lua synopsis number mechanismHandle=sim.getMechanismHandle(string mechanismName)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page