This documentation is archived and is not being maintained.

SslStream.EndAuthenticateAsClient Method

Ends a pending asynchronous server authentication operation started with a previous call to BeginAuthenticateAsServer.

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

public virtual void EndAuthenticateAsClient(
	IAsyncResult asyncResult
)

Parameters

asyncResult
Type: System.IAsyncResult

An IAsyncResult instance returned by a call to BeginAuthenticateAsServer.

ExceptionCondition
ArgumentNullException

asyncResult is null.

ArgumentException

asyncResult was not created by a call to BeginAuthenticateAsServer.

AuthenticationException

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

InvalidOperationException

There is no pending server authentication to complete.

If the operation has not completed, this method blocks until it does. When the 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.

To perform this operation synchronously, use one of the AuthenticateAsServer methods.

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: