SocketAsyncEventArgs.ConnectByNameError Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

'Declaration
Public ReadOnly Property ConnectByNameError As Exception
public Exception ConnectByNameError { get; }

Property Value

Type: System.Exception
A Exception that indicates the cause of the connection error when a DnsEndPoint was specified for the RemoteEndPoint property.

Remarks

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 nulla null reference (Nothing in Visual Basic).

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.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.