CryptEnumProvidersA 函数 (wincrypt.h)

  • 项目
重要 此 API 已弃用。 新的和现有的软件应开始使用 加密下一代 API。 Microsoft 可能会在将来的版本中删除此 API。
 
CryptEnumProviders 函数 (CSP) 检索第一个或下一个可用的加密服务提供程序。 此函数在循环中使用，可以按顺序检索计算机上可用的所有 CSP。

可能的 CSP 包括 Microsoft 基本加密提供程序版本 1.0 和 Microsoft 增强型加密提供程序版本 1.0。

语法

BOOL CryptEnumProvidersA(
  [in]      DWORD dwIndex,
  [in]      DWORD *pdwReserved,
  [in]      DWORD dwFlags,
  [out]     DWORD *pdwProvType,
  [out]     LPSTR szProvName,
  [in, out] DWORD *pcbProvName
);

参数

[in] dwIndex

要枚举的下一个提供程序的索引。

[in] pdwReserved

保留供将来使用，必须为 NULL。

[in] dwFlags

保留供将来使用，必须为零。

[out] pdwProvType

指定枚举提供程序类型的 DWORD 值的地址。

[out] szProvName

指向从枚举提供程序接收数据的缓冲区的指针。 这是一个包含终止 null 字符的字符串。

此参数可以为 NULL ，用于设置名称的大小以用于内存分配。 有关详细信息，请参阅 检索长度未知的数据。

[in, out] pcbProvName

指向 DWORD 值的指针，该值指定 pszProvName 参数指向的缓冲区的大小（以字节为单位）。 函数返回时， DWORD 值包含缓冲区中存储的字节数。

注意 处理缓冲区中返回的数据时，应用程序必须使用返回的数据的实际大小。 实际大小可以略小于输入时指定的缓冲区的大小。 (输入时，缓冲区大小通常指定得足够大，以确保最大的输出数据适合 buffer。) 输出时，此参数指向的变量将更新，以反映复制到缓冲区的数据的实际大小。
 

返回值

如果函数成功，则返回值为非零 (TRUE) 。

如果函数失败，则返回值为零， (FALSE) 。 有关扩展的错误信息，请调用 GetLastError。

NTE 开头的错误代码由使用的特定 CSP 生成。 一些可能的错误代码随之而来。

返回代码 说明
ERROR_MORE_DATA
 pszProvName 缓冲区不够大，无法保存提供程序名称。
ERROR_NO_MORE_ITEMS
 没有更多项要枚举。
ERROR_NOT_ENOUGH_MEMORY
 操作系统内存不足。
NTE_BAD_FLAGS
 dwFlags 参数具有无法识别的值。
NTE_FAIL
 类型注册出现问题。

注解

此函数枚举计算机上可用的提供程序。 可以使用 CryptEnumProviderTypes 枚举提供程序类型。

示例

以下示例演示一个循环，其中列出了所有可用的加密服务提供程序。 有关使用 CryptEnumProviders 函数的另一个示例，请参阅 示例 C 程序：枚举 CSP 提供程序和提供程序类型。

#include <stdio.h>
#include <windows.h>
#include <Wincrypt.h>
#pragma comment(lib, "advapi32.lib")

void main()
{

    //---------------------------------------------------------------
    // Copyright (C) Microsoft.  All rights reserved.
    // Declare and initialize variables.

    DWORD       cbName;
    DWORD       dwType;
    DWORD       dwIndex;
    CHAR        *pszName = NULL; 

    // Print header lines for providers.
    printf("Listing Available Providers:\n");
    printf("Provider type\tProvider Name\n");
    printf("_____________\t__________________"
        "___________________\n");   

    //--------------------------------------------------------------- 
    // Loop through enumerating providers.
    dwIndex = 0;
    while(CryptEnumProviders(
           dwIndex,
           NULL,
           0,
           &dwType,
           NULL,
           &cbName
           ))
    {

        //-----------------------------------------------------------
        //  cbName returns the length of the name of the next 
        //  provider. Allocate memory in a buffer to retrieve 
        //  that name.

        if (!(pszName = (LPTSTR)LocalAlloc(LMEM_ZEROINIT, cbName)))
        {
           printf("ERROR - LocalAlloc failed\n");
           exit(1);
        }
        //-----------------------------------------------------------
        //  Get the provider name.
        if (CryptEnumProviders(
               dwIndex++,
               NULL,
               0,
               &dwType,
               pszName,
               &cbName
               ))
        {
            printf ("     %4.0d\t%s\n",dwType, pszName);
        }
        else
        {
            printf("ERROR - CryptEnumProviders failed.\n");
            exit(1);
        }
        LocalFree(pszName);

    } // End of while loop

    printf("\nProvider types and provider names "
        "have been listed.\n");
}

注意

wincrypt.h 标头将 CryptEnumProviders 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

要求 值
最低受支持的客户端 Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 wincrypt.h
Library Advapi32.lib
DLL Advapi32.dll

另请参阅

CryptEnumProviderTypes

服务提供程序函数