BCryptQueryContextFunctionProperty-Funktion (bcrypt.h)

Artikel
08/22/2023

Die BCryptQueryContextFunctionProperty-Funktion ruft den Wert einer benannten Eigenschaft für eine kryptografische Funktion in einem vorhandenen CNG-Kontext ab.

Syntax

NTSTATUS BCryptQueryContextFunctionProperty(
  [in]      ULONG   dwTable,
  [in]      LPCWSTR pszContext,
  [in]      ULONG   dwInterface,
  [in]      LPCWSTR pszFunction,
  [in]      LPCWSTR pszProperty,
  [in, out] ULONG   *pcbValue,
  [in, out] PUCHAR  *ppbValue
);

Parameter

[in] dwTable

Gibt die Konfigurationstabelle an, in der der Kontext vorhanden ist. Dies kann einer der folgenden Werte sein.

Wert	Bedeutung
CRYPT_LOCAL	Der Kontext ist in der Konfigurationstabelle des lokalen Computers vorhanden.
CRYPT_DOMAIN	Dieser Wert steht nicht zur Verwendung zur Verfügung.

[in] pszContext

Ein Zeiger auf eine mit NULL beendete Unicode-Zeichenfolge, die den Bezeichner des Kontexts enthält, aus dem die Funktionseigenschaft abgerufen werden soll.

[in] dwInterface

Gibt die kryptografische Schnittstelle an, in der die Funktion vorhanden ist. Dies kann einer der folgenden Werte sein.

Wert	Bedeutung
BCRYPT_ASYMMETRIC_ENCRYPTION_INTERFACE	Die Funktion ist in der Liste der asymmetrischen Verschlüsselungsfunktionen enthalten.
BCRYPT_CIPHER_INTERFACE	Die Funktion ist in der Liste der Verschlüsselungsfunktionen vorhanden.
BCRYPT_HASH_INTERFACE	Die Funktion ist in der Liste der Hashfunktionen vorhanden.
BCRYPT_RNG_INTERFACE	Die Funktion ist in der Liste der Zufallszahlengeneratorfunktionen vorhanden.
BCRYPT_SECRET_AGREEMENT_INTERFACE	Die Funktion ist in der Liste der Geheimvereinbarungsfunktionen vorhanden.
BCRYPT_SIGNATURE_INTERFACE	Die Funktion ist in der Liste der Signaturfunktionen vorhanden.
NCRYPT_KEY_STORAGE_INTERFACE	Die Funktion ist in der Liste der Schlüsselspeicherfunktionen vorhanden.
NCRYPT_SCHANNEL_INTERFACE	Die Funktion ist in der Liste der Schannel-Funktionen vorhanden.

[in] pszFunction

Ein Zeiger auf eine Unicode-Zeichenfolge mit NULL-Beendigung, die den Bezeichner der kryptografischen Funktion enthält, für die die Eigenschaft abgerufen werden soll.

[in] pszProperty

Ein Zeiger auf eine Unicode-Zeichenfolge mit Null-Beendigung, die den Bezeichner der abzurufenden Eigenschaft enthält.

[in, out] pcbValue

Die Adresse einer ULONG-Variablen , die beim Eintrag die Größe des Puffers in Bytes enthält, auf den ppbValue verweist. Wenn diese Größe nicht groß genug ist, um den Eigenschaftswert zu halten, schlägt diese Funktion mit STATUS_BUFFER_TOO_SMALL fehl.

Nachdem diese Funktion zurückgegeben wurde, enthält diese Variable die Anzahl der Bytes, die in den ppbValue-Puffer kopiert wurden.

[in, out] ppbValue

Die Adresse eines Zeigers auf einen Puffer, der die Eigenschaftendaten empfängt. Die Größe und das Format dieses Puffers hängen vom Format der abgerufenen Eigenschaft ab. Der Wert, auf den der parameter pcbValue verweist, enthält die Größe dieses Puffers.

Wenn der Wert, auf den dieser Parameter verweist, NULL ist, weist diese Funktion den erforderlichen Arbeitsspeicher zu. Dieser Speicher muss freigegeben werden, wenn er nicht mehr benötigt wird, indem dieser Zeiger an die BCryptFreeBuffer-Funktion übergeben wird.

Wenn dieser Parameter NULL ist, platziert diese Funktion die erforderliche Größe in Bytes in der Variablen, auf die der pcbValue-Parameter verweist, und gibt STATUS_BUFFER_TOO_SMALL zurück.

Rückgabewert

Gibt einen status Code zurück, der den Erfolg oder Fehler der Funktion angibt.

Mögliche Rückgabecodes umfassen folgendes, sind aber nicht darauf beschränkt.

Rückgabecode	Beschreibung
STATUS_SUCCESS	Die Funktion war erfolgreich.
STATUS_BUFFER_TOO_SMALL	Der ppbValue-Parameter ist nicht NULL, und der Wert, auf den der pcbValue-Parameter verweist, ist nicht groß genug, um den Satz von Kontexten zu enthalten.
STATUS_INVALID_PARAMETER	Mindestens ein Parameter ist ungültig.
STATUS_NO_MEMORY	Ein Fehler bei der Speicherzuordnung ist aufgetreten.
STATUS_NOT_FOUND	Der angegebene Kontext, die angegebene Funktion oder eigenschaft konnte nicht gefunden werden.

Hinweise

BCryptQueryContextFunctionProperty kann nur im Benutzermodus aufgerufen werden.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	bcrypt.h
Bibliothek	Bcrypt.lib
DLL	Bcrypt.dll

Freigeben über