CngKey.GetProperty(String, CngPropertyOptions) Метод

Определение

Получает свойство по заданному имени и набору параметров.

public:
 System::Security::Cryptography::CngProperty GetProperty(System::String ^ name, System::Security::Cryptography::CngPropertyOptions options);
public System.Security.Cryptography.CngProperty GetProperty (string name, System.Security.Cryptography.CngPropertyOptions options);
[System.Security.SecurityCritical]
public System.Security.Cryptography.CngProperty GetProperty (string name, System.Security.Cryptography.CngPropertyOptions options);
member this.GetProperty : string * System.Security.Cryptography.CngPropertyOptions -> System.Security.Cryptography.CngProperty
[<System.Security.SecurityCritical>]
member this.GetProperty : string * System.Security.Cryptography.CngPropertyOptions -> System.Security.Cryptography.CngProperty
Public Function GetProperty (name As String, options As CngPropertyOptions) As CngProperty

Параметры

name
String

Имя требуемого свойства.

options
CngPropertyOptions

Битовая комбинация значений перечисления, определяющих параметры именованного свойства.

Возвращаемое значение

Объект, в котором содержится необработанное значение заданного свойства.

Атрибуты

Исключения

name имеет значение null.

Все остальные ошибки.

Комментарии

Цель этого метода — возврат значения произвольного свойства ключа. Типичным способом получения свойств является использование методов доступа к свойствам, предоставляемых классом CngKey . CngKey предоставляет оболочки для нескольких, но не всех свойств. Метод GetProperty в основном используется для доступа к значению свойства, которое не упаковано в оболочку.

Этот метод полезен в следующих случаях:

  • Новая версия операционной системы поддерживает новое свойство ключа шифрования следующего поколения (CNG), которое не имеет оболочки.

  • Вы добавляете пользовательское свойство в ключ.

Параметр options используется специально для указания следующего:

  • Является ли свойство встроенным или настраиваемым.

  • Указывает, следует ли сохранять свойство с помощью ключа.

Эти параметры должны соответствовать значению, которое было задано свойству, иначе свойство не будет найдено.

CryptographicException возникает, если свойство не удается найти. Сначала следует вызвать HasProperty метод , чтобы избежать исключения, а не упаковать вызов метода в try/catch блок.

Применяется к