EventStructure class/Get Handled Events method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 5191802
Scope VI Scripting
Data Name GetHandledEvents
Short Name* GetHandledEvents
Long Name* Get Handled Events
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 16458
Owning Class Name EventStructure Class
Return Data Type No return value
Invoke Node Get Handled Events
Available in Real-Time Operating SystemYes
Available in Run-Time EngineNo
Loads the block diagram into memoryYes
Loads the front panel into memoryYes
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningNo

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 type Name Required Description
I32 Frame Index Yes Specifies the index for the frame, or event case, that contains the configured events you want to return.
Common Cluster Array 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.
Common Cluster Array 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.
Numeric Cluster Array Dynamic Events Yes Returns an array of clusters containing the dynamic event type and the order that dynamic events are registered.

Uses

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links