Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Socket::DisconnectAsync Method (SocketAsyncEventArgs^)

 

Begins an asynchronous request to disconnect from a remote endpoint.

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

public:
bool DisconnectAsync(
	SocketAsyncEventArgs^ e
)

Parameters

e
Type: System.Net.Sockets::SocketAsyncEventArgs^

The System.Net.Sockets::SocketAsyncEventArgs object to use for this asynchronous socket operation.

Return Value

Type: System::Boolean

Returns true if the I/O operation is pending. The SocketAsyncEventArgs::Completed event on the e parameter will be raised upon completion of the operation.

Returns false if the I/O operation completed synchronously. In this case, The SocketAsyncEventArgs::Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.

Exception Condition
ArgumentNullException

The e parameter cannot be null.

InvalidOperationException

A socket operation was already in progress using the System.Net.Sockets::SocketAsyncEventArgs object specified in the e parameter.

NotSupportedException

Windows XP or later is required for this method.

ObjectDisposedException

The Socket has been closed.

SocketException

An error occurred when attempting to access the socket.

When using a connection-oriented protocol, calling the DisconnectAsync method requests a disconnect from a remote endpoint. If you set SocketAsyncEventArgs::DisconnectReuseSocket to true in the e parameter, the socket can be reused.

.NET Framework
Available since 2.0
Return to top
Show:
© 2017 Microsoft