Regular API function


Description Gets the up-state label of an OpenGl-based custom UI button (useful to retrieve the text in an edit-box style button). See also simSetUIButtonLabel.
C synopsis simChar* simGetUIButtonLabel(simInt uiHandle,simInt buttonHandle)
C parameters
uiHandle: OpenGl-based custom UI handle
buttonHandle: handle of a button inside the specified OpenGl-based custom UI
C return value
label of the button, or NULL in case of an error. The user is in charge of releasing the returned string with simReleaseBuffer
Lua synopsis string label=simGetUIButtonLabel(number uiHandle,number buttonHandle)
Lua parameters
Same as C-function
Lua return values
Same as C-function (but nil instead of NULL, and simReleaseBuffer does not need to be called)

All regular API functions on one page