X500DistinguishedNameFlags Enum

Definition

Specifies characteristics of the X.500 distinguished name.

This enumeration supports a bitwise combination of its member values.

C#
[System.Flags]
public enum X500DistinguishedNameFlags
Inheritance
X500DistinguishedNameFlags
Attributes

Fields

Name Value Description
None 0

The distinguished name has no special characteristics.

Reversed 1

The distinguished name is reversed.

UseSemicolons 16

The distinguished name uses semicolons.

DoNotUsePlusSign 32

The distinguished name does not use the plus sign.

DoNotUseQuotes 64

The distinguished name does not use quotation marks.

UseCommas 128

The distinguished name uses commas.

UseNewLines 256

The distinguished name uses the new line character.

UseUTF8Encoding 4096

The distinguished name uses UTF8 encoding instead of Unicode character encoding.

UseT61Encoding 8192

The distinguished name uses T61 encoding.

ForceUTF8Encoding 16384

Forces the distinguished name to encode specific X.500 keys as UTF-8 strings rather than printable Unicode strings. For more information and the list of X.500 keys affected, see the X500NameFlags enumeration.

Examples

The following code example shows how to use the X500DistinguishedNameFlags enumeration.

C#
using System;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;

class X500Sample
{
    static void Main()
    {
        try
        {
            X509Store store = new("MY", StoreLocation.CurrentUser);
            store.Open(OpenFlags.ReadOnly | OpenFlags.OpenExistingOnly);
            X509Certificate2Collection collection = store.Certificates;
            X509Certificate2Collection fcollection = collection.Find(
                X509FindType.FindByTimeValid,
                DateTime.Now, false
                );
            X509Certificate2Collection scollection = X509Certificate2UI.SelectFromCollection(
                fcollection,
                "Test Certificate Select",
                "Select a certificate from the following list to get information on that certificate",
                X509SelectionFlag.MultiSelection
                );
            Console.WriteLine($"Number of certificates: {scollection.Count}{Environment.NewLine}");
            foreach (X509Certificate2 x509 in scollection)
            {
                X500DistinguishedName dname = new(
                    x509.SubjectName.Name,
                    X500DistinguishedNameFlags.Reversed | X500DistinguishedNameFlags.UseSemicolons
                    );
                Console.WriteLine("X500DistinguishedName: {0}{1}", dname.Name, Environment.NewLine);
                x509.Reset();
            }
            store.Close();
        }
        catch (CryptographicException)
        {
            Console.WriteLine("Information could not be written out for this certificate.");
        }
    }
}

Remarks

This enumeration is used with the X500DistinguishedName class to indicate special characters contained in the distinguished name.

Several values are mutually exclusive in this enumeration; use only one of these values to define the special characteristics of an X.500 distinguished name. For example, specify only one of the UseCommas, UseNewLines , and UseSemicolons values. You would also specify either UseT61Encoding or UseUTF8Encoding.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1