HttpWebClientProtocol.ClientCertificates Property (System.Web.Services.Protocols)

Switch View :
ScriptFree
.NET Framework Class Library
HttpWebClientProtocol.ClientCertificates Property

Gets the collection of client certificates.

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)
Syntax

Visual Basic
<BrowsableAttribute(False)> _
Public ReadOnly Property ClientCertificates As X509CertificateCollection
	Get
C#
[BrowsableAttribute(false)]
public X509CertificateCollection ClientCertificates { get; }
Visual C++
[BrowsableAttribute(false)]
public:
property X509CertificateCollection^ ClientCertificates {
	X509CertificateCollection^ get ();
}
F#
[<BrowsableAttribute(false)>]
member ClientCertificates : X509CertificateCollection

Property Value

Type: System.Security.Cryptography.X509Certificates.X509CertificateCollection
An X509CertificateCollection that represents the client certificates.
Remarks

This property allows a client to pass one or more client certificates, also known as Authenticode X.509 v.3 certificates, when calling an XML Web service method. If the XML Web service method has been configured to use client certificates, a client certificate can be used as one mechanism for authenticating a client. For details on setting up client certificates, see the Internet Information Services (IIS) documentation.

Examples

The following code example demonstrates how to load in a client certificate from a file and then add it to the ClientCertificates property for calling an XML Web service method that uses client certificates for authentication.

Visual Basic

' Create a new instance of a proxy class for the Bank XML Web service.
Dim bank As BankSession = new BankSession()

' Load the client certificate from a file.
Dim x509 As X509Certificate = X509Certificate.CreateFromCertFile("c:\user.cer")

' Add the client certificate to the ClientCertificates property of the proxy class.
bank.ClientCertificates.Add(x509)

' Communicate with the Deposit XML Web service method,
' which requires authentication using client certificates.
bank.Deposit(500)


C#

// Create a new instance of a proxy class for the Bank XML Web service.
BankSession bank = new BankSession();

// Load the client certificate from a file.
X509Certificate x509 = X509Certificate.CreateFromCertFile(@"c:\user.cer");

// Add the client certificate to the ClientCertificates property of the proxy class.
bank.ClientCertificates.Add(x509);

// Communicate with the Deposit XML Web service method,
// which requires authentication using client certificates.
bank.Deposit(500);


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also

Reference

Other Resources