This topic has not yet been rated - Rate this topic

SocketAsyncEventArgs.UserToken Property

.NET Framework 4

Other Versions

Gets or sets a user or application object associated with this asynchronous socket operation.

Namespace: System.Net.Sockets
Assembly: System (in System.dll)

Syntax

C++

Copy

public Object UserToken { get; set; }

Property Value

Type: System.Object
An object that represents the user or application object associated with this asynchronous socket operation.

Remarks

This property can be used by an application to associate an application state object with the SocketAsyncEventArgs object. Primarily, this property is a way for an application to pass state to the application’s event handler (for example, the asynchronous operation completion method).

This property is used with all of the asynchronous socket (xxxAsync) methods.

Version Information

.NET Framework

Supported in: 4, 3.5 SP1, 3.0 SP1, 2.0 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.