NCryptQueryProtectionDescriptorName-Funktion (ncryptprotect.h)

  • Artikel

Die NCryptQueryProtectionDescriptorName-Funktion ruft die Schutzdeskriptorregelzeichenfolge ab, die einem registrierten Deskriptoranzeigenamen zugeordnet ist.

Syntax

SECURITY_STATUS NCryptQueryProtectionDescriptorName(
  [in]      LPCWSTR pwszName,
  [out]     LPWSTR  pwszDescriptorString,
  [in, out] SIZE_T  *pcDescriptorString,
            DWORD   dwFlags
);

Parameter

[in] pwszName

Der registrierte Anzeigename für den Schutzdeskriptor. Registrieren Sie einen Namen, indem Sie die Funktion NCryptRegisterProtectionDescriptorName aufrufen.

[out] pwszDescriptorString

Eine mit NULL endende Unicode-Zeichenfolge, die die Schutzdeskriptorregel enthält. Legen Sie diesen Wert auf NULL fest, und legen Sie beim ersten Aufruf dieser Funktion die Größe der Deskriptorzeichenfolge fest, auf die das Argument pcDescriptorString verweist. Weitere Informationen finden Sie in den Hinweisen.

[in, out] pcDescriptorString

Zeiger auf eine Variable, die die Anzahl der Zeichen in der im pwszDescriptorString-Parameter abgerufenen Zeichenfolge enthält. Legen Sie die Variable beim ersten Aufruf dieser Funktion auf 0 fest. Weitere Informationen finden Sie in den Hinweisen.

dwFlags

Flag, das angibt, welche Registrierungsstruktur nach dem registrierten Namen abzufragen ist. Dies kann null sein, um in der HKEY_CURRENT_USER Struktur zu suchen, oder Sie können NCRYPT_MACHINE_KEY_FLAG angeben, um die HKEY_LOCAL_MACHINE Hive abzufragen.

Rückgabewert

Gibt einen status Code zurück, der den Erfolg oder Fehler der Funktion angibt. Mögliche Rückgabecodes sind u. a. die folgenden:

Rückgabecode Beschreibung
ERROR_SUCCESS
 Die Funktion war erfolgreich.
NTE_INVALID_PARAMETER
 Der pwszName-Parameter darf nicht NULL sein, und der Wert, auf den der Parameter verweist, kann keine leere Zeichenfolge sein.
NTE_BAD_FLAGS
 Der dwFlags-Parameter muss null oder NCRYPT_MACHINE_KEY_FLAG sein.

Hinweise

Um eine Schutzdeskriptorregelzeichenfolge abzurufen, müssen Sie diese Funktion zweimal aufrufen. Legen Sie beim ersten Aufruf das Argument pwszDescriptorString auf NULL und den Wert, auf den das Argument pcDescriptorString verweist, auf Null fest. Ihr erster Aufruf ruft die Anzahl der Zeichen in der Deskriptorzeichenfolge ab. Verwenden Sie diese Zahl, um Arbeitsspeicher für die Zeichenfolge zuzuweisen und einen Zeiger auf den zugeordneten Puffer abzurufen. Um die Zeichenfolge abzurufen, rufen Sie die Funktion mithilfe des Zeigers erneut auf.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2012 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile ncryptprotect.h
Bibliothek NCrypt.lib
DLL NCrypt.dll

Weitere Informationen

CNG DPAPI-Funktionen

NCryptRegisterProtectionDescriptorName