Regular API function

simSetUIButtonLabel
remote API equivalent: simxSetUIButtonLabel
RosPlugin API equivalent: simRosSetUIButtonLabel

Description Sets the up-state and down-state labels of an OpenGl-based custom UI button. See also simGetUIButtonLabel.
C synopsis simInt simSetUIButtonLabel(simInt uiHandle,simInt buttonHandle,const simChar* upStateLabel,const simChar* downStateLabel)
C parameters
uiHandle: OpenGl-based custom UI handle
buttonHandle: button handle
upStateLabel: pointer to a string containing the label of the button when it is up. Can be NULL.
downStateLabel: pointer to a string containing the label of the button when it is down. Can be NULL.
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis number result=simSetUIButtonLabel(number uiHandle,number buttonHandle,string upStateLabel,string downStateLabel)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page