SslStream.BeginAuthenticateAsClient Method (String, X509CertificateCollection, SslProtocols, Boolean, AsyncCallback, Object)

Called by clients to begin an asynchronous operation to authenticate the server and optionally the client using the specified certificates and security protocol.

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

public virtual IAsyncResult BeginAuthenticateAsClient (
	string targetHost,
	X509CertificateCollection clientCertificates,
	SslProtocols enabledSslProtocols,
	bool checkCertificateRevocation,
	AsyncCallback asyncCallback,
	Object asyncState
)
public IAsyncResult BeginAuthenticateAsClient (
	String targetHost, 
	X509CertificateCollection clientCertificates, 
	SslProtocols enabledSslProtocols, 
	boolean checkCertificateRevocation, 
	AsyncCallback asyncCallback, 
	Object asyncState
)
public function BeginAuthenticateAsClient (
	targetHost : String, 
	clientCertificates : X509CertificateCollection, 
	enabledSslProtocols : SslProtocols, 
	checkCertificateRevocation : boolean, 
	asyncCallback : AsyncCallback, 
	asyncState : Object
) : IAsyncResult
Not applicable.

Parameters

targetHost

The name of the server that shares this SslStream.

clientCertificates

The X509CertificateCollection containing client certificates.

enabledSslProtocols

The SslProtocols value that represents the protocol used for authentication.

checkCertificateRevocation

A Boolean value that specifies whether the certificate revocation list is checked during authentication.

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.

Return Value

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

Exception typeCondition

ArgumentNullException

targetHost is a null reference (Nothing in Visual Basic).

ArgumentException

enabledSslProtocols is not a valid SslProtocols value.

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.

The value specified for targetHost must match the name on the server's certificate.

The asynchronous authentication operation must be completed by calling the EndAuthenticateAsClient 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 AuthenticateAsClient method overloads.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously

If you receive a AuthenticationException, 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:

Client certificates are not supported in the SSL version 2 protocol.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: