OPC Studio User's Guide and Reference
Cookie Property (AEEventData)



OpcLabs.EasyOpcClassicCore Assembly > OpcLabs.EasyOpc.AlarmsAndEvents Namespace > AEEventData Class : Cookie Property
Server defined cookie associated with the event notification.
Syntax
'Declaration
 
<ValueRangeAttribute(0, 4294967295)>
Public Property Cookie As Long
'Usage
 
Dim instance As AEEventData
Dim value As Long
 
instance.Cookie = value
 
value = instance.Cookie
[ValueRange(0, 4294967295)]
public long Cookie {get; set;}
[ValueRange(0, 4294967295)]
public:
property int64 Cookie {
   int64 get();
   void set (    int64 value);
}

Property Value

Valid values of this property are in the range from 0 to 4294967295.

The default value of this property is 0.

Exceptions
ExceptionDescription

The value of an argument is outside the allowable range of values as defined by the invoked method.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

This property is used only for Condition-Related Events (see EventType).

The cookie is used by the client when acknowledging the condition. This value is opaque to the client.

Requirements

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

See Also