SslStream.EndAuthenticateAsClient(IAsyncResult) Method

Definition

Namespace:

System.Net.Security

Assembly:

System.Net.Security.dll

Source:

SslStream.cs

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

public:
 virtual void EndAuthenticateAsClient(IAsyncResult ^ asyncResult);

public virtual void EndAuthenticateAsClient (IAsyncResult asyncResult);

abstract member EndAuthenticateAsClient : IAsyncResult -> unit
override this.EndAuthenticateAsClient : IAsyncResult -> unit

Public Overridable Sub EndAuthenticateAsClient (asyncResult As IAsyncResult)

Parameters

asyncResult

IAsyncResult

An IAsyncResult instance returned by a call to BeginAuthenticateAsClient.

Exceptions

ArgumentNullException

asyncResult is null.

ArgumentException

asyncResult was not created by a call to BeginAuthenticateAsClient.

AuthenticationException

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

InvalidOperationException

There is no pending server authentication to complete.

Remarks

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 AuthenticateAsClient methods.