SocketAsyncEventArgs.ConnectByNameError Property

 

Gets the exception in the case of a connection failure when a DnsEndPoint was used.

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

public Exception ConnectByNameError { get; }

Property Value

Type: System.Exception

An Exception that indicates the cause of the connection error when a DnsEndPoint was specified for the RemoteEndPoint property.

In the case of a connection failure when a DnsEndPoint was specified for the RemoteEndPoint property, the ConnectByNameError property will contain the exception that indicates the detailed cause of the socket error.

When an IPEndPoint was specified for the RemoteEndPoint property and a connection failure occurs, the ConnectByNameError property will be a null reference.

The SocketError property is always set in the case of a connection failure. The ConnectByNameError property contains more information about the failure if it was a failure connecting to a DnsEndPoint. If an application is only interested in whether the connect operation succeeded or failed, then the application only needs to check the SocketError property.

Universal Windows Platform
Available since 10
.NET Framework
Available since 4.0
Silverlight
Available since 3.0
Windows Phone Silverlight
Available since 7.1
Return to top
Show: