ホーム › Security.Cryptography › CryptEnumProviderTypesW

CryptEnumProviderTypesW

関数

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

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

シグネチャ

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

BOOL CryptEnumProviderTypesW(
    DWORD dwIndex,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    DWORD* pdwProvType,
    LPWSTR szTypeName,   // optional
    DWORD* pcbTypeName
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

コンピューターでサポートされている暗号化サービスプロバイダー (CSP) の種類を、最初のものから順に、または次のものを取得します。(Unicode)

戻り値

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

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

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

戻り値	説明
ERROR_NO_MORE_ITEMS	列挙する項目がこれ以上ありません。
ERROR_NOT_ENOUGH_MEMORY	オペレーティングシステムのメモリが不足しました。
NTE_BAD_FLAGS	dwFlags パラメーターに認識できない値が指定されています。
NTE_FAIL	種類の登録に問題がありました。

解説(Remarks)

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

例

次の例は、利用可能なすべての暗号化サービスプロバイダー種類を列挙して一覧表示するループを示します。

#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       dwIndex;
    DWORD       dwType;
    DWORD       cbName;
    LPTSTR      pszName;

    //--------------------------------------------------------------
    //   Print header lines for provider types.

    printf("Listing Available Provider Types:\n");
    printf("Provider type\tProvider Type Name\n");
    printf("_____________\t_____________________________________\n");

    // Loop through enumerating provider types.
    dwIndex = 0;
    while(CryptEnumProviderTypes(
           dwIndex,
           NULL,
           0,
           &dwType,
           NULL,
           &cbName
           ))
    {

        //-----------------------------------------------------------
        //  cbName returns the length of the name of the next
        //  provider type. 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 type name.

        if (CryptEnumProviderTypes(
               dwIndex++,
               NULL,
               NULL,
               &dwType,   
               pszName,
               &cbName))     
        {
            printf ("     %4.0d\t%s\n",dwType, pszName);
        }
        else
        {
            printf("ERROR - CryptEnumProviderTypes\n");
            exit(1);
        }
        LocalFree(pszName);
    } // End of while loop.
}

CryptEnumProviderTypes 関数を使用する別の例については、Example C Program: Enumerating CSP Providers and Provider Types を参照してください。

メモ

wincrypt.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CryptEnumProviderTypes を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存ではないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じることがあります。詳細については、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 CryptEnumProviderTypesW(
    DWORD dwIndex,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    DWORD* pdwProvType,
    LPWSTR szTypeName,   // optional
    DWORD* pcbTypeName
);

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

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

' dwIndex : DWORD
' pdwReserved : DWORD* optional
' dwFlags : DWORD
' pdwProvType : DWORD* out
' szTypeName : LPWSTR optional, out
' pcbTypeName : DWORD* in/out
Declare PtrSafe Function CryptEnumProviderTypesW Lib "advapi32" ( _
    ByVal dwIndex As Long, _
    ByVal pdwReserved As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef pdwProvType As Long, _
    ByVal szTypeName As LongPtr, _
    ByRef pcbTypeName 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

CryptEnumProviderTypesW = ctypes.windll.advapi32.CryptEnumProviderTypesW
CryptEnumProviderTypesW.restype = wintypes.BOOL
CryptEnumProviderTypesW.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,  # szTypeName : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbTypeName : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptEnumProviderTypesW = Fiddle::Function.new(
  lib['CryptEnumProviderTypesW'],
  [
    -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,  # szTypeName : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcbTypeName : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn CryptEnumProviderTypesW(
        dwIndex: u32,  // DWORD
        pdwReserved: *mut u32,  // DWORD* optional
        dwFlags: u32,  // DWORD
        pdwProvType: *mut u32,  // DWORD* out
        szTypeName: *mut u16,  // LPWSTR optional, out
        pcbTypeName: *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 CryptEnumProviderTypesW(uint dwIndex, IntPtr pdwReserved, uint dwFlags, out uint pdwProvType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szTypeName, ref uint pcbTypeName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptEnumProviderTypesW' -Namespace Win32 -PassThru
# $api::CryptEnumProviderTypesW(dwIndex, pdwReserved, dwFlags, pdwProvType, szTypeName, pcbTypeName)

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

出力引数:

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