BCryptGetProperty 函数 （bcrypt.h）

BCryptGetProperty 函数检索 CNG 对象的命名属性的值。

语法

NTSTATUS BCryptGetProperty(
  [in]  BCRYPT_HANDLE hObject,
  [in]  LPCWSTR       pszProperty,
  [out] PUCHAR        pbOutput,
  [in]  ULONG         cbOutput,
  [out] ULONG         *pcbResult,
  [in]  ULONG         dwFlags
);

参数

[in] hObject

表示要为其获取属性值的 CNG 对象的句柄。

[in] pszProperty

指向以 null 结尾的 Unicode 字符串的指针，该字符串包含要检索的属性的名称。 这可以是预定义 的加密基元属性标识符 之一或自定义属性标识符。

[out] pbOutput

接收属性值的缓冲区的地址。 cbOutput 参数包含此缓冲区的大小。

[in] cbOutput

pbOutput 缓冲区的大小（以字节为单位）。

[out] pcbResult

指向 ULONG 变量的指针，该变量接收复制到 pbOutput 缓冲区的字节数。 如果 pbOutput 参数是 NULL，此函数会将所需大小（以字节为单位）放置在此参数指向的位置。

[in] dwFlags

一组标志，用于修改此函数的行为。 此函数未定义任何标志。

对于 ML-KEM，此参数必须设置为零。

返回值

返回一个状态代码，指示函数的成功或失败。

可能的返回代码包括但不限于以下代码：

注解

若要获取属性所需的大小，请传递 NULLpbOutput 参数。 此函数将所需的大小（以字节为单位）放置在 由result 参数指向的值中。

根据提供程序支持的处理器模式，可以从用户模式或内核模式调用 BCryptGetProperty 。 内核模式调用方可以在 PASSIVE_LEVELIRQL 或 DISPATCH_LEVEL IRQL 上执行。 如果当前 IRQL 级别 DISPATCH_LEVEL，则传递给 BCryptGetProperty 函数的任何指针都必须引用非分页（或锁定）内存。 如果 hObject 参数中指定的对象是句柄，则必须使用 BCRYPT_PROV_DISPATCH 标志打开它。

BCRYPT_PARAMETER_SET_NAME 属性必须在 BCrypt ML-DSA 键上设置，然后才能使用。 可以从键对象中检索该数据。

若要在内核模式下调用此函数，请使用 Cng.lib，这是驱动程序开发工具包（DDK）的一部分。 Windows Server 2008 和 Windows Vista： 若要在内核模式下调用此函数，请使用 Ksecdd.lib。

要求