ホーム › Security.Cryptography › CryptEnumProvidersW

CryptEnumProvidersW

関数

システムに登録された暗号プロバイダーを列挙する(Unicode版)。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL CryptEnumProvidersW(
    DWORD dwIndex,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    DWORD* pdwProvType,
    LPWSTR szProvName,   // optional
    DWORD* pcbProvName
);

パラメーター

名前	型	方向	説明
dwIndex	DWORD	in	次に列挙するプロバイダーのインデックス。
pdwReserved	DWORD*	optional	将来の使用のために予約されており、NULL である必要があります。
dwFlags	DWORD	in	将来の使用のために予約されており、ゼロである必要があります。
pdwProvType	DWORD*	out	列挙されたプロバイダーの種類を示す DWORD 値のアドレス。
szProvName	LPWSTR	outoptional	列挙されたプロバイダーから取得したデータを受け取るバッファーへのポインター。これは終端の null 文字を含む文字列です。このパラメーターは、メモリ割り当てのために名前のサイズを設定する目的で NULL にできます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbProvName	DWORD*	inout	pszProvName パラメーターが指すバッファーのサイズ(バイト単位)を指定する DWORD 値へのポインター。関数が戻ると、この DWORD 値にはバッファーに格納されたバイト数が入ります。注バッファーに返されたデータを処理する際、アプリケーションは実際に返されたデータのサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さい場合があります。(入力時には、想定される最大の出力データが収まるよう、バッファーサイズは通常十分に大きく指定されます。)出力時には、このパラメーターが指す変数がバッファーにコピーされたデータの実際のサイズを反映するよう更新されます。

戻り値の型: BOOL

公式ドキュメント

重要この API は非推奨です。(CryptEnumProvidersW)

戻り値

関数が成功した場合、戻り値はゼロ以外(TRUE)です。

関数が失敗した場合、戻り値はゼロ(FALSE)です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

NTE で始まるエラーコードは、使用されている特定の CSP によって生成されます。考えられるエラーコードの一部を以下に示します。

戻り値	説明
ERROR_MORE_DATA	pszProvName バッファーがプロバイダー名を保持するのに十分な大きさではありませんでした。
ERROR_NO_MORE_ITEMS	列挙する項目がこれ以上ありません。
ERROR_NOT_ENOUGH_MEMORY	オペレーティングシステムのメモリが不足しました。
NTE_BAD_FLAGS	dwFlags パラメーターに認識できない値が指定されています。
NTE_FAIL	種類の登録に問題がありました。

解説(Remarks)

この関数は、コンピューター上で利用可能なプロバイダーを列挙します。プロバイダーの種類は、 CryptEnumProviderTypes を使用して列挙できます。

例

次の例は、利用可能なすべての暗号化サービスプロバイダーを一覧表示するループを示しています。CryptEnumProviders 関数を使用する別の例については、Example C Program: Enumerating CSP Providers and Provider Types を参照してください。

#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 プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CryptEnumProviders を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーが発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL CryptEnumProvidersW(
    DWORD dwIndex,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    DWORD* pdwProvType,
    LPWSTR szProvName,   // optional
    DWORD* pcbProvName
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CryptEnumProvidersW(
    uint dwIndex,   // DWORD
    IntPtr pdwReserved,   // DWORD* optional
    uint dwFlags,   // DWORD
    out uint pdwProvType,   // DWORD* out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szProvName,   // LPWSTR optional, out
    ref uint pcbProvName   // DWORD* in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptEnumProvidersW(
    dwIndex As UInteger,   ' DWORD
    pdwReserved As IntPtr,   ' DWORD* optional
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef pdwProvType As UInteger,   ' DWORD* out
    <MarshalAs(UnmanagedType.LPWStr)> szProvName As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcbProvName As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwIndex : DWORD
' pdwReserved : DWORD* optional
' dwFlags : DWORD
' pdwProvType : DWORD* out
' szProvName : LPWSTR optional, out
' pcbProvName : DWORD* in/out
Declare PtrSafe Function CryptEnumProvidersW Lib "advapi32" ( _
    ByVal dwIndex As Long, _
    ByVal pdwReserved As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef pdwProvType As Long, _
    ByVal szProvName As LongPtr, _
    ByRef pcbProvName As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptEnumProvidersW = ctypes.windll.advapi32.CryptEnumProvidersW
CryptEnumProvidersW.restype = wintypes.BOOL
CryptEnumProvidersW.argtypes = [
    wintypes.DWORD,  # dwIndex : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwReserved : DWORD* optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwProvType : DWORD* out
    wintypes.LPWSTR,  # szProvName : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbProvName : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptEnumProvidersW = Fiddle::Function.new(
  lib['CryptEnumProvidersW'],
  [
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pdwReserved : DWORD* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pdwProvType : DWORD* out
    Fiddle::TYPE_VOIDP,  # szProvName : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcbProvName : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn CryptEnumProvidersW(
        dwIndex: u32,  // DWORD
        pdwReserved: *mut u32,  // DWORD* optional
        dwFlags: u32,  // DWORD
        pdwProvType: *mut u32,  // DWORD* out
        szProvName: *mut u16,  // LPWSTR optional, out
        pcbProvName: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CryptEnumProvidersW(uint dwIndex, IntPtr pdwReserved, uint dwFlags, out uint pdwProvType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szProvName, ref uint pcbProvName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptEnumProvidersW' -Namespace Win32 -PassThru
# $api::CryptEnumProvidersW(dwIndex, pdwReserved, dwFlags, pdwProvType, szProvName, pcbProvName)

#uselib "ADVAPI32.dll"
#func global CryptEnumProvidersW "CryptEnumProvidersW" wptr, wptr, wptr, wptr, wptr, wptr
; CryptEnumProvidersW dwIndex, varptr(pdwReserved), dwFlags, varptr(pdwProvType), varptr(szProvName), varptr(pcbProvName)   ; 戻り値は stat
; dwIndex : DWORD -> "wptr"
; pdwReserved : DWORD* optional -> "wptr"
; dwFlags : DWORD -> "wptr"
; pdwProvType : DWORD* out -> "wptr"
; szProvName : LPWSTR optional, out -> "wptr"
; pcbProvName : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CryptEnumProvidersW "CryptEnumProvidersW" int, var, int, var, var, var
; res = CryptEnumProvidersW(dwIndex, pdwReserved, dwFlags, pdwProvType, szProvName, pcbProvName)
; dwIndex : DWORD -> "int"
; pdwReserved : DWORD* optional -> "var"
; dwFlags : DWORD -> "int"
; pdwProvType : DWORD* out -> "var"
; szProvName : LPWSTR optional, out -> "var"
; pcbProvName : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CryptEnumProvidersW "CryptEnumProvidersW" int, sptr, int, sptr, sptr, sptr
; res = CryptEnumProvidersW(dwIndex, varptr(pdwReserved), dwFlags, varptr(pdwProvType), varptr(szProvName), varptr(pcbProvName))
; dwIndex : DWORD -> "int"
; pdwReserved : DWORD* optional -> "sptr"
; dwFlags : DWORD -> "int"
; pdwProvType : DWORD* out -> "sptr"
; szProvName : LPWSTR optional, out -> "sptr"
; pcbProvName : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。