CreateX509CertificateIdentity(String,String) Method

Creates a user token represented by an X.509 certificate.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Public Overloads Shared Function CreateX509CertificateIdentity( _
   ByVal fileName As String, _
   ByVal password As String _
) As UserIdentity

'Usage
 
Dim fileName As String
Dim password As String
Dim value As UserIdentity
 
value = UserIdentity.CreateX509CertificateIdentity(fileName, password)

[NotNull()]
public static UserIdentity CreateX509CertificateIdentity( 
   string fileName,
   string password
)

[NotNull()]
public:
static UserIdentity^ CreateX509CertificateIdentity( 
   String^ fileName,
   String^ password
)

Parameters

fileName: The name of a certificate file.
The value of this parameter cannot be null (Nothing in Visual Basic).
password: The password required to access the X.509 certificate data.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns a new user identity, configured with X509 certificate token only.

This method never returns null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentException

One of the arguments provided to a method is not valid.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

UserIdentity Class
UserIdentity Members
Overload List

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.