CRYPTPROTECT_PROMPTSTRUCT structure (dpapi.h)

  • Article

The CRYPTPROTECT_PROMPTSTRUCT structure provides the text of a prompt and information about when and where that prompt is to be displayed when using the CryptProtectData and CryptUnprotectData functions.

Syntax

typedef struct _CRYPTPROTECT_PROMPTSTRUCT {
  DWORD   cbSize;
  DWORD   dwPromptFlags;
  HWND    hwndApp;
  LPCWSTR szPrompt;
} CRYPTPROTECT_PROMPTSTRUCT, *PCRYPTPROTECT_PROMPTSTRUCT;

Members

cbSize

The size, in bytes, of this structure.

dwPromptFlags

DWORD flags that indicate when prompts to the user are to be displayed. Current dwPromptFlags values are as follows.

Value Meaning
CRYPTPROTECT_PROMPT_ON_PROTECT
 This flag is used to provide the prompt for the protect phase.
CRYPTPROTECT_PROMPT_ON_UNPROTECT
 This flag can be combined with CRYPTPROTECT_PROMPT_ON_PROTECT to enforce the UI (user interface) policy of the caller. When CryptUnprotectData is called, the dwPromptFlags specified in the CryptProtectData call are enforced.

hwndApp

Window handle to the parent window.

szPrompt

A string containing the text of a prompt to be displayed.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header dpapi.h

See also

CryptProtectData

CryptUnprotectData