This documentation is archived and is not being maintained.

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.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

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.
Show: