通过

NCryptEnumKeys 函数 (ncrypt.h)

  • 项目

NCryptEnumKeys 函数获取提供程序存储的密钥的名称。

语法

SECURITY_STATUS NCryptEnumKeys(
  [in]           NCRYPT_PROV_HANDLE hProvider,
  [in, optional] LPCWSTR            pszScope,
  [out]          NCryptKeyName      **ppKeyName,
  [in, out]      PVOID              *ppEnumState,
  [in]           DWORD              dwFlags
);

参数

[in] hProvider

要枚举其密钥的密钥存储提供程序的句柄。 此句柄是通过 NCryptOpenStorageProvider 函数获取的。

[in, optional] pszScope

此参数当前未使用，必须为 NULL。

[out] ppKeyName

指向接收检索的密钥名称的 NCryptKeyName 结构的指针的地址。 当应用程序完成使用此内存后，通过调用 NCryptFreeBuffer 函数释放它。

[in, out] ppEnumState

VOID 指针的地址，该指针接收在此函数的后续调用中使用的枚举状态信息。 此信息仅对密钥存储提供程序有意义，对调用方是不透明的。 密钥存储提供程序使用此信息来确定枚举中的下一项。 如果此参数指向的变量包含 NULL，则枚举将从头开始。

如果不再需要此内存，则必须通过将此指针传递给 NCryptFreeBuffer 函数来释放该内存。

[in] dwFlags

修改函数行为的标志。 这可以是零，也可以是以下一个或多个值的组合。

值 含义
NCRYPT_MACHINE_KEY_FLAG
 枚举本地计算机的键。 如果此标志不存在，则枚举当前用户密钥。
NCRYPT_SILENT_FLAG
 请求关键服务提供程序 (KSP) 不显示任何用户界面。 如果提供程序必须显示 UI 才能运行，则调用会失败，KSP 应将 NTE_SILENT_CONTEXT 错误代码设置为最后一个错误。

返回值

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

可能的返回代码包括但不限于以下内容。

返回代码 说明
ERROR_SUCCESS
 函数成功。
NTE_BAD_FLAGS
 dwFlags 参数包含无效的值。
NTE_INVALID_HANDLE
 hProvider 参数无效。
NTE_INVALID_PARAMETER
 一个或多个参数无效。
NTE_NO_MEMORY
 发生内存分配失败。
NTE_NO_MORE_ITEMS
 已到达枚举的末尾。
NTE_SILENT_CONTEXT
 dwFlags 参数包含 NCRYPT_SILENT_FLAG 标志，但枚举的密钥需要用户交互。

注解

每次调用此函数时，此函数仅检索一个项。 枚举的状态存储在 ppEnumState 参数指向的变量中，因此必须在调用此函数之间保留此状态。 检索到提供程序存储的最后一个密钥后，此函数将在下次调用时返回 NTE_NO_MORE_ITEMS 。 若要开始枚举，请将 ppEnumState 参数指向的变量设置为 NULL，释放 ppKeyName 参数指向的内存（如果它不是 NULL），然后再次调用此函数。

服务不得从其 StartService 函数调用此函数。 如果服务从其 StartService 函数调用此函数，则可能会出现死锁，并且服务可能会停止响应。

要求

要求 值
最低受支持的客户端 Windows Vista [桌面应用 | UWP 应用]
最低受支持的服务器 Windows Server 2008 [桌面应用 | UWP 应用]
目标平台 Windows
标头 ncrypt.h
Library Ncrypt.lib
DLL Ncrypt.dll