SocketAsyncEventArgs.UserToken Property

Definition

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

C#
public object UserToken { get; set; }
C#
public object? UserToken { get; set; }

Property Value

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.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

See also