CryptGetDefaultProviderA 函式 (wincrypt.h)

重要 此 API 已被取代。 新的和現有的軟體應該開始使用 密碼編譯新一代 API。 Microsoft 可能會在未來的版本中移除此 API。

 

CryptGetDefaultProvider函式會尋找本機電腦或目前使用者指定提供者類型的預設密碼編譯服務提供者 (CSP) 。 pszProvName緩衝區中會傳回dwProvType參數中所指定提供者類型的預設 CSP 名稱。

語法

BOOL CryptGetDefaultProviderA(
  [in]      DWORD dwProvType,
  [in]      DWORD *pdwReserved,
  [in]      DWORD dwFlags,
  [out]     LPSTR pszProvName,
  [in, out] DWORD *pcbProvName
);

參數

[in] dwProvType

要找到預設 CSP 名稱的提供者類型。

定義的提供者類型如下所示：

• PROV_RSA_FULL
• PROV_RSA_SIG
• PROV_DSS
• PROV_DSS_DH
• PROV_DH_SCHANNEL
• PROV_FORTEZZA
• PROV_MS_EXCHANGE
• PROV_RSA_SCHANNEL
• PROV_SSL

[in] pdwReserved

此參數保留供日後使用，且必須是 Null。

[in] dwFlags

定義下列旗標值。

值	意義
CRYPT_USER_DEFAULT 0x00000002	傳回指定型別的使用者內容預設 CSP。
CRYPT_MACHINE_DEFAULT 0x00000001	傳回指定類型的電腦預設 CSP。

[out] pszProvName

Null 終止字元字串緩衝區的指標，可接收預設 CSP 的名稱。

若要尋找緩衝區的大小以供記憶體配置之用，此參數可以是 Null。 如需詳細資訊，請參閱 擷取未知長度的資料。

[in, out] pcbProvName

DWORD值的指標，指定pszProvName參數所指向之緩衝區的大小，以位元組為單位。 當函式傳回時， DWORD 值會包含儲存或儲存在緩衝區中的位元組數目。

注意 處理緩衝區中傳回的資料時，應用程式必須使用傳回之資料的實際大小。 實際大小可能比輸入上指定的緩衝區大小稍微小一點。 (輸入時，通常會指定足夠的緩衝區大小，以確保最大可能的輸出資料符合 buffer.) On 輸出中，此參數所指向的變數會更新，以反映複製到緩衝區的資料的實際大小。

 

傳回值

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

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

NTE 前面出現的錯誤碼是由所使用的特定 CSP 所產生。 可能的錯誤碼包括下列專案。

傳回碼	描述
ERROR_INVALID_PARAMETER	其中一個參數包含不正確值。 這通常是不正確指標。
ERROR_MORE_DATA	名稱的緩衝區不夠大。
ERROR_NOT_ENOUGH_MEMORY	作業系統記憶體不足。
NTE_BAD_FLAGS	dwFlags參數具有無法辨識的值。

備註

此函式會決定本機電腦或目前使用者目前設定為預設值的已安裝 CSP。 此資訊通常會向使用者顯示。

範例

下列範例會擷取PROV_RSA_FULL提供者類型的預設 CSP 名稱。 如需使用此函式的另一個範例，請參閱 範例 C 程式：列舉 CSP 提供者和提供者類型。

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

void main()
{

    DWORD       cbProvName=0;
    LPTSTR      pbProvName=NULL;
    // Copyright (C) Microsoft.  All rights reserved.
    // Get the length of the RSA_FULL default provider name.
    if (!(CryptGetDefaultProvider(
         PROV_RSA_FULL, 
         NULL, 
         CRYPT_MACHINE_DEFAULT,
         NULL, 
         &cbProvName))) 
    { 
      printf("Error getting the length of the default "
          "provider name.\n");
      exit(1);
    }

    // Allocate local memory for the name of the default provider.
    if (!(pbProvName = (LPTSTR)LocalAlloc(LMEM_ZEROINIT, 
        cbProvName)))
    {
        printf("Error during memory allocation for "
            "provider name.\n");
        exit(1);
    }

    // Get the default provider name.
    if (CryptGetDefaultProvider(
        PROV_RSA_FULL, 
        NULL, 
        CRYPT_MACHINE_DEFAULT,
        pbProvName,
        &cbProvName)) 
    {
        printf("The default provider name is %s\n",pbProvName);
    }
    else
    {
        printf("Getting the name of the provider failed.\n");
        exit(1);
    }

    // Free resources when done.
    LocalFree(pbProvName);

}

注意

wincrypt.h 標頭會根據 UNICODE 預處理器常數的定義，將 CryptGetDefaultProvider 定義為別名，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

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

另請參閱

CryptSetProvider

CryptSetProviderEx

服務提供者函式