System.Net.Security.SslStream.BeginAuthenticateAsClient Method

Called by clients to begin an asynchronous operation to authenticate the server and optionally the client.

Syntax

public virtual IAsyncResult BeginAuthenticateAsClient (string targetHost, AsyncCallback asyncCallback, object asyncState)

Parameters

targetHost
The name of the server that shares this System.Net.Security.SslStream.
asyncCallback
An AsyncCallback delegate that references the method to invoke when the authentication is complete.
asyncState
A user-defined object that contains information about the operation. This object is passed to the asyncCallback delegate when the operation completes.

Returns

An IAsyncResult object that indicates the status of the asynchronous operation.

Remarks

This method authenticates using System.Security.Authentication.SslProtocols.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.

The asynchronous authentication operation must be completed by calling the SslStream.EndAuthenticateAsClient(IAsyncResult) method. Typically, the method is invoked by the asyncCallback delegate.

This method does not block while the operation completes. To block until the operation completes, use one of the erload:System.Net.Security.SslStream.AuthenticateAsClient method overloads.

For detailed information about using the asynchronous programming model, see Asynchronous Programming Overview

If you receive a System.Security.Authentication.AuthenticationException, this System.Net.Security.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.

Requirements

Namespace: System.Net.Security
Assembly: System (in System.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0