FromAEEvent Method

Converts an OPC Alarms&Events event object to an event payload.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
<JetBrains.Annotations.ContractAnnotationAttribute("null => null; notnull => notnull")>
Public Shared Function FromAEEvent( _
   ByVal eventData As AEEventData _
) As AEEventDataPayload

'Usage
 
Dim eventData As AEEventData
Dim value As AEEventDataPayload
 
value = AEEventDataPayload.FromAEEvent(eventData)

[JetBrains.Annotations.CanBeNull()]
[JetBrains.Annotations.ContractAnnotation("null => null; notnull => notnull")]
public static AEEventDataPayload FromAEEvent( 
   AEEventData eventData
)

[JetBrains.Annotations.CanBeNull()]
[JetBrains.Annotations.ContractAnnotation("null => null; notnull => notnull")]
public:
static AEEventDataPayload^ FromAEEvent( 
   AEEventData^ eventData
)

Parameters

eventData: Event data.
The value of this parameter can be null (Nothing in Visual Basic).

Return Value

Returns an event payload containing the data from the event object.

This method can return null (Nothing in Visual Basic).

Remarks

In languages that support implicit conversions (such as C# or VB.NET), in many cases you do not have call this method explicitly. When indicated, a call to an available equivalent implicit conversion operator will be created by the compiler automatically.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

AEEventDataPayload Class
AEEventDataPayload Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.