Get Handled Events Method

Short Name: GetHandledEvents

Requires: Base Development System

Class: EventStructure Methods

To Use: Create a method.

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

Data typeNameRequiredDescription
Frame IndexYesSpecifies the index for the frame, or event case, that contains the configured events you want to return.
Static App/VI EventsYesReturns 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 EventsYesReturns 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 EventsYesReturns 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.

Data typeNo return value
Available in Run-Time EngineNo
Available in Real-Time Operating SystemYes
Settable when the VI is runningNo
Loads the front panel into memoryYes
Need to authenticate before useNo
Loads the block diagram into memoryYes
Remote access allowedYes