Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

SslStream.AuthenticateAsClientAsync Method (String)

.NET Framework 4.6 and 4.5

Called by clients to authenticate the server and optionally the client in a client-server connection as an asynchronous operation.

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

'Declaration
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)> _
Public Overridable Function AuthenticateAsClientAsync ( _
	targetHost As String _
) As Task

Parameters

targetHost
Type: System.String

The name of the server that shares this SslStream.

Return Value

Type: System.Threading.Tasks.Task
Returns Task
The task object representing the asynchronous operation.

ExceptionCondition
ArgumentNullException

targetHost is Nothing.

AuthenticationException

The authentication failed and left this object in an unusable state.

InvalidOperationException

Authentication has already occurred.

-or-

Server authentication using this SslStream was tried previously.

-or-

Authentication is already in progress.

ObjectDisposedException

This object has been closed.

This method authenticates using Default. No client certificates are used in the authentication. The certificate revocation list is not checked during authentication. The value specified for targetHost must match the name on the server's certificate.

When authentication succeeds, you must check the IsEncrypted and IsSigned properties to determine what security services are used by the SslStream. Check the IsMutuallyAuthenticated property to determine whether mutual authentication occurred.

If the authentication fails, you receive a AuthenticationException, and this SslStream is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.6, 4.5
Show:
© 2015 Microsoft