BeginAuthenticateAsServer Method (X509Certificate, AsyncCallback, Object)

SslStream::BeginAuthenticateAsServer Method (X509Certificate^, AsyncCallback^, Object^)

 

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

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

public:
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
virtual IAsyncResult^ BeginAuthenticateAsServer(
	X509Certificate^ serverCertificate,
	AsyncCallback^ asyncCallback,
	Object^ asyncState
)

Parameters

serverCertificate
Type: System.Security.Cryptography.X509Certificates::X509Certificate^

The X509Certificate used to authenticate the server.

asyncCallback
Type: System::AsyncCallback^

An AsyncCallback delegate that references the method to invoke when the authentication is complete.

asyncState
Type: System::Object^

A user-defined object that contains information about the operation. This object is passed to the asyncCallback delegate when the operation completes.

Return Value

Type: System::IAsyncResult^

An IAsyncResult object indicating the status of the asynchronous operation.

Exception Condition
ArgumentNullException

serverCertificate is null.

AuthenticationException

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

InvalidOperationException

Authentication has already occurred.

-or-

Client authentication using this SslStream was tried previously.

-or-

Authentication is already in progress.

ObjectDisposedException

This object has been closed.

PlatformNotSupportedException

The BeginAuthenticateAsServer method is not supported on Windows 95, Windows 98, or Windows Millennium.

This method authenticates using Default. The certificate revocation list is not checked during authentication. The client is not required to provide a certificate for authentication.

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.

Win9xFamily

The BeginAuthenticateAsServer method is not supported.

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft