Regular API function

simGetDialogInput / sim.getDialogInput (remote API equivalent: simxGetDialogInput)

Description Queries the text of the edit box of a generic dialog box of style sim_dlgstyle_input. To be used after sim.displayDialog was called and after sim.getDialogResult returned sim.dlgret_ok
C synopsis simChar* simGetDialogInput(simInt genericDialogHandle)
C parameters
genericDialogHandle: handle of the generic dialog
C return value
Pointer to a text buffer or NULL in case of an error. The user is in charge of releasing the returned string with simReleaseBuffer.
Lua synopsis string input=sim.getDialogInput(number genericDialogHandle)
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