BCryptSetProperty-Funktion (bcrypt.h)

Artikel
02/26/2024

Die BCryptSetProperty-Funktion legt den Wert einer benannten Eigenschaft für ein CNG-Objekt fest.

Syntax

NTSTATUS BCryptSetProperty(
  [in, out] BCRYPT_HANDLE hObject,
  [in]      LPCWSTR       pszProperty,
  [in]      PUCHAR        pbInput,
  [in]      ULONG         cbInput,
  [in]      ULONG         dwFlags
);

Parameter

[in, out] hObject

Ein Handle, das das CNG-Objekt darstellt, für das der Eigenschaftswert festgelegt werden soll.

[in] pszProperty

Ein Zeiger auf eine Unicode-Zeichenfolge, die null endet und den Namen der festzulegenden Eigenschaft enthält. Dies kann einer der vordefinierten Bezeichner von primitiven Kryptografieeigenschaften oder ein benutzerdefinierter Eigenschaftenbezeichner sein.

[in] pbInput

Die Adresse eines Puffers, der den neuen Eigenschaftswert enthält. Der cbInput-Parameter enthält die Größe dieses Puffers.

[in] cbInput

Die Größe des pbInput-Puffers in Bytes.

[in] dwFlags

Ein Satz von Flags, die das Verhalten dieser Funktion ändern. Für diese Funktion sind keine Flags definiert.

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
STATUS_SUCCESS	Die Funktion war erfolgreich.
STATUS_INVALID_HANDLE	Das Handle im hObject-Parameter ist ungültig.
STATUS_INVALID_PARAMETER	Mindestens ein Parameter ist ungültig.
STATUS_NOT_SUPPORTED	Die vom pszProperty-Parameter angegebene benannte Eigenschaft wird nicht unterstützt oder ist schreibgeschützt.

Hinweise

Je nachdem, welche Prozessormodi ein Anbieter unterstützt, kann BCryptSetProperty entweder aus dem Benutzermodus oder dem Kernelmodus aufgerufen werden. Aufrufer im Kernelmodus können entweder am PASSIVE_LEVELIRQL oder DISPATCH_LEVEL IRQL ausgeführt werden. Wenn die aktuelle IRQL-Ebene DISPATCH_LEVEL ist, müssen alle an BCryptSetProperty übergebenen Zeiger auf nicht ausseitigen (oder gesperrten) Speicher verweisen. Wenn das im hObject-Parameter angegebene Objekt ein Handle ist, muss es mit dem flag BCRYPT_PROV_DISPATCH geöffnet worden sein.

Um diese Funktion im Kernelmodus aufzurufen, verwenden Sie Cng.lib, die Teil des Driver Development Kit (DDK) ist. Windows Server 2008 und Windows Vista: Verwenden Sie Ksecdd.lib, um diese Funktion im Kernelmodus aufzurufen.

Wenn Sie den Wert für die Eigenschaft BCRYPT_CHAINING_MODE festlegen, wird der pbInput-Parameter von cbInput nicht gebunden. Der Aufrufer muss sicherstellen, dass eine gültige Unicode-Zeichenfolge mit NULL-Endung bereitgestellt wird.

Anforderungen

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