Cookie Property (AEEventData)

Server defined cookie associated with the event notification.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ValueLimitsAttribute(0, 4294967295)>
Public Property Cookie As Long

'Usage
 
Dim instance As AEEventData
Dim value As Long
 
instance.Cookie = value
 
value = instance.Cookie

[ValueLimits(0, 4294967295)]
public long Cookie {get; set;}

[ValueLimits(0, 4294967295)]
public:
property int64 Cookie {
   int64 get();
   void set (    int64 value);
}

Property Value

The default value of this property is 0.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	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.

Exception

Description

System.ArgumentOutOfRangeException

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

Reference

AEEventData Class
AEEventData 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.