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 блок.

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