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.) On 輸出中，此參數所指向的變數會更新，以反映複製到緩衝區的數據的實際大小。

 

傳回值

如果函式成功，則傳回值為非零 (TRUE) 。

如果函式失敗，則傳回值為零， (FALSE) 。 如需擴充錯誤資訊，請呼叫 GetLastError。

NTE 前面出現的錯誤碼是由所使用的特定 CSP 所產生。 以下是一些可能的錯誤碼。

傳回碼	Description
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 標頭會根據 UNICODE 預處理器常數的定義，將 CryptEnumProviders 定義為別名，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	wincrypt.h
程式庫	Advapi32.lib
Dll	Advapi32.dll

另請參閱

CryptEnumProviderTypes

服務提供者函式