Edit

Share via

NCRYPT_UI_POLICY_BLOB structure

  • Article

The NCRYPT_UI_POLICY_BLOB structure is used with the NCRYPT_UI_POLICY_PROPERTY property to contain user interface information for a key.

Syntax

typedef struct __NCRYPT_UI_POLICY_BLOB {
  DWORD dwVersion;
  DWORD dwFlags;
  DWORD cbCreationTitle;
  DWORD cbFriendlyName;
  DWORD cbDescription;
} NCRYPT_UI_POLICY_BLOB;

Members

dwVersion

The version number of the structure. This member must contain 1.

dwFlags

A set of flags that provide additional user interface information or requirements.

Value Meaning
NCRYPT_UI_PROTECT_KEY_FLAG
0x00000001
 Display the strong key user interface as needed.
NCRYPT_UI_FORCE_HIGH_PROTECTION_FLAG
0x00000002
 Force high protection.

cbCreationTitle

The length, in bytes, of the creation title. The creation title is a null-terminated Unicode string that specifies the text that is used as the title of the strong key dialog box when the key is completed. The creation title must be placed immediately following the NCRYPT_UI_POLICY_BLOB structure. If the value of the cbCreationTitle member is set to 0, a default creation title is used for the title of the strong key dialog box. This member is only used on key finalization.

cbFriendlyName

The length, in bytes, of the friendly name of the key. The friendly name is a null-terminated Unicode string that contains the text that is displayed in the strong key dialog box as the name of the key. The friendly name must be placed immediately following the creation title in this BLOB. If the value of the cbFriendlyName member is set to 0, a default name is used in the strong key dialog box. This member is used both when the key is completed and when the key is used.

cbDescription

The length, in bytes, of the key description. The key description is a null-terminated Unicode string that contains the text that is displayed in the strong key dialog box as the description of the key. The description value must be placed immediately following the friendly name in this BLOB. If the value of the cbDescription member is set to 0, a default description is used in the strong key dialog box. This member is used both when the key is completed and when the key is used.

Remarks

This structure is included in the Ncrypt_provider.h header. To use the structure, you must download the Cryptographic Provider Development Kit from Microsoft Connect.

Requirements

Requirement Value
Minimum supported client
 Windows Vista [desktop apps only]
Minimum supported server
 Windows Server 2008 [desktop apps only]
Header
Ncrypt_provider.h