Regular API function

simGetUIHandle
remote API equivalent: simxGetUIHandle
RosPlugin API equivalent: simRosGetUIHandle

Description Retrieves the handle of an OpenGl-based custom UI. 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.
C synopsis simInt simGetUIHandle(const simChar* uiName)
C parameters
uiName: name of the OpenGl-based custom UI
C return value
handle of OpenGl-based custom UI if value >=0, -1 if operation was not successful
Lua synopsis number uiHandle=simGetUIHandle(string uiName)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page