Export (0) Print
Expand All

SslStream.AuthenticateAsClient Method (String)

Called by clients to authenticate the server and optionally the client in a client-server connection.

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

'Declaration
Public Overridable Sub AuthenticateAsClient ( _
	targetHost As String _
)
'Usage
Dim instance As SslStream 
Dim targetHost As String

instance.AuthenticateAsClient(targetHost)

Parameters

targetHost
Type: System.String

The name of the server that shares this SslStream.

ExceptionCondition
ArgumentNullException

targetHost is Nothing.

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.

This method authenticates using 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.

When 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.

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

Community Additions

ADD
Show:
© 2014 Microsoft