GuiGetMsg()

Called by a script to let the user interact with open windows, and to wait until some Window Layout (ie, object) script calls GuiWake() to indicate that some event has happened which should be processed by the script that has called GuiGetMsg.

error = GuiGetMsg(Operation, Signals)


Args

Operation is the operation to perform. It must be one of the following:

Operation
Meaning
'PROCESS' Perform user interaction and wait for a wake-up signal.
'CLEAR' Clear any pending messages for all windows, and return immediately (ie, don't wait for a wake-up signal).

If Operation is omitted, then it defaults to 'PROCESS'.

Signals are whatever other wake-up signals should be watched (in addition to events that are reported via "Window messages" such as all GUI events). If omitted, then there are no additional signals to watch for.


Returns

If successful, an empty string is returned, and the variable named GuiObject is set to the (upper-cased) name of the object that called GuiWake (or DROP'ed if it wasn't an object script that called GuiWake). Also, the variable named GuiSignal is set to whatever was passed to GuiWake.

If an error occurs, GuiGetMsg instead returns an error message.