QueueUserEvent

int QueueUserEvent (int eventNumber, int panelHandle, int controlID);

Purpose

Inserts a programmer-defined event in the GetUserEvent queue. You can later retrieve the event by calling GetUserEvent.

Event numbers 1,000 to 10,000 are reserved for programmer-defined events. You can assign any meaning you choose to the event number.

Parameters

Input
Name Type Description
eventNumber integer An integer value between 1,000 and 10,000 that this function places in the event queue and that you can later retrieve from GetUserEvent.
panelHandle integer Specifier for a particular panel that is currently in memory.

You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.

Pass 0 when the event does not apply to a particular panel.
controlID integer Defined constant, located in the .uir header file, that you assign to the control in the User Interface Editor, or the ID that you obtain from NewCtrl or DuplicateCtrl.

Pass 0 when the event does not apply to a particular control.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success