State Property

Gets the object that was included as part of the associated method call.

[Visual Basic]
Public ReadOnly Property State As Object

[C#]
public object State {get;}

[C++]
public: __property Object* get_State();

[C++/CLI]
public:
property Object^ State {
   Object^ get();
}

Return Type

An object containing data passed into the calling asynchronous method.

Remarks

The EndEventArgs.State property can be used in the calling asynchronous method to make data accessible to the handling event.

This property is useful for making data accessible to the handling event. Since asynchronous methods are "disconnected" (meaning that when one is called, it executes on it's own and returns in the event handler) data that you were using in the code that called the asynchronous method may not be available in the event handler. Simply pass this data in as state when calling the asynchronous method (usually a BeginXXX method) and it is available in the event handler. If you do not wish to make an object accessible in the EndXXX event, simple pass in null as state.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows ME, Windows 2000, Windows XP, Windows Server 2003, Windows Vista

See Also

DnsEventArgs Class  | DnsEventArgs Members