Get Handled Events
- Updated2026-02-04
- 2 minute(s) read
Gets all events configured for a given frame, or event case, to handle. This method returns the events in separate outputs grouped by registration type and refnum class.
Parameters
| Name | Data type | Required | Description |
|---|---|---|---|
| Frame Index |  |
Yes | Specifies the index for the frame, or event case, that contains the configured events you want to return. |
| Static App/VI Events |  |
Yes | Returns an array of clusters containing the application or VI event type for events statically handled by the given event case, the lossy queue limit, and whether the front panel locks until the event case completes. |
| Static Control Events | |
Yes | Returns an array of clusters containing each statically handled control or pane event type, the GObject refnum of the associated control, the lossy event limit count for the event type, and whether the front panel locks until the event case completes. |
| Dynamic Events |  |
Yes | Returns an array of clusters containing the dynamic event type and the order that dynamic events are registered. |
Remarks
The following table lists the characteristics of this method.
| Short Name | GetHandledEvents |
| Data type | No return value |
| Available in Run-Time Engine | No |
| Available in Real-Time Operating System | No |
| Settable when the VI is running | No |
| Loads the front panel into memory | Yes |
| Need to authenticate before use | No |
| Loads the block diagram into memory | Yes |
| Remote access allowed | Yes |