Win32 API 日本語リファレンス
ホームSecurity.Cryptography › BCryptEnumRegisteredProviders

BCryptEnumRegisteredProviders

関数
登録済みのCNG暗号プロバイダーを列挙して一覧を取得する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// bcrypt.dll
#include <windows.h>

NTSTATUS BCryptEnumRegisteredProviders(
    DWORD* pcbBuffer,
    CRYPT_PROVIDERS** ppBuffer   // optional
);

パラメーター

名前方向説明
pcbBufferDWORD*inout

ULONG 値へのポインターです。入力時には、ppBuffer パラメーターが指すバッファーのサイズ(バイト単位)を格納します。出力時には、バッファーにコピーされたバイト数、または必要なバッファーサイズ(バイト単位)のいずれかを受け取ります。

注意 これはバッファー全体の合計サイズ(バイト単位)であり、CRYPT_PROVIDERS 構造体のサイズのみではありません。バッファーは、CRYPT_PROVIDERS 構造体に加えて、プロバイダーに関するその他のデータも保持できる必要があります。
ppBufferCRYPT_PROVIDERS**outoptional

バッファーポインターへのポインターです。登録済みプロバイダーのコレクションを記述する CRYPT_PROVIDERS 構造体とその他のデータを受け取ります。

このパラメーターが NULL の場合、この関数は STATUS_BUFFER_TOO_SMALL を返し、すべてのデータに必要なサイズ(バイト単位)を pcbBuffer パラメーターが指す値に格納します。

このパラメーターが NULL ポインターのアドレスである場合、この関数は必要なメモリを割り当て、プロバイダーに関する情報をそのメモリに格納し、そのメモリへのポインターをこのパラメーターに設定します。このメモリの使用が終わったら、このポインターを BCryptFreeBuffer 関数に渡して解放してください。

このパラメーターが非 NULL ポインターのアドレスである場合、この関数はプロバイダー情報をこのバッファーにコピーします。pcbBuffer パラメーターには、バッファー全体のサイズ(バイト単位)を格納しておく必要があります。バッファーがすべてのプロバイダー情報を保持するのに十分な大きさでない場合、この関数は STATUS_BUFFER_TOO_SMALL を返します。

戻り値の型: NTSTATUS

公式ドキュメント

登録済みプロバイダーに関する情報を取得します。

戻り値

関数の成功または失敗を示すステータスコードを返します。

返される可能性のあるコードには、以下のものが含まれますが、これらに限定されません。

戻り値コード 説明
STATUS_SUCCESS
関数は成功しました。
STATUS_BUFFER_TOO_SMALL
pcbBuffer パラメーターで指定されたサイズが、すべてのデータを保持するのに十分な大きさではありません。
STATUS_INVALID_PARAMETER
1 つ以上のパラメーターが無効です。

解説(Remarks)

BCryptEnumRegisteredProviders 関数は、次の 2 つの方法のいずれかで呼び出すことができます。

BCryptEnumRegisteredProviders はユーザーモードでのみ呼び出すことができます。

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

各言語での呼び出し定義

// bcrypt.dll
#include <windows.h>

NTSTATUS BCryptEnumRegisteredProviders(
    DWORD* pcbBuffer,
    CRYPT_PROVIDERS** ppBuffer   // optional
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptEnumRegisteredProviders(
    ref uint pcbBuffer,   // DWORD* in/out
    IntPtr ppBuffer   // CRYPT_PROVIDERS** optional, out
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptEnumRegisteredProviders(
    ByRef pcbBuffer As UInteger,   ' DWORD* in/out
    ppBuffer As IntPtr   ' CRYPT_PROVIDERS** optional, out
) As Integer
End Function
' pcbBuffer : DWORD* in/out
' ppBuffer : CRYPT_PROVIDERS** optional, out
Declare PtrSafe Function BCryptEnumRegisteredProviders Lib "bcrypt" ( _
    ByRef pcbBuffer As Long, _
    ByVal ppBuffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BCryptEnumRegisteredProviders = ctypes.windll.bcrypt.BCryptEnumRegisteredProviders
BCryptEnumRegisteredProviders.restype = ctypes.c_int
BCryptEnumRegisteredProviders.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # pcbBuffer : DWORD* in/out
    ctypes.c_void_p,  # ppBuffer : CRYPT_PROVIDERS** optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptEnumRegisteredProviders = Fiddle::Function.new(
  lib['BCryptEnumRegisteredProviders'],
  [
    Fiddle::TYPE_VOIDP,  # pcbBuffer : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ppBuffer : CRYPT_PROVIDERS** optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "bcrypt")]
extern "system" {
    fn BCryptEnumRegisteredProviders(
        pcbBuffer: *mut u32,  // DWORD* in/out
        ppBuffer: *mut *mut CRYPT_PROVIDERS  // CRYPT_PROVIDERS** optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptEnumRegisteredProviders(ref uint pcbBuffer, IntPtr ppBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptEnumRegisteredProviders' -Namespace Win32 -PassThru
# $api::BCryptEnumRegisteredProviders(pcbBuffer, ppBuffer)
#uselib "bcrypt.dll"
#func global BCryptEnumRegisteredProviders "BCryptEnumRegisteredProviders" sptr, sptr
; BCryptEnumRegisteredProviders varptr(pcbBuffer), varptr(ppBuffer)   ; 戻り値は stat
; pcbBuffer : DWORD* in/out -> "sptr"
; ppBuffer : CRYPT_PROVIDERS** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "bcrypt.dll"
#cfunc global BCryptEnumRegisteredProviders "BCryptEnumRegisteredProviders" var, var
; res = BCryptEnumRegisteredProviders(pcbBuffer, ppBuffer)
; pcbBuffer : DWORD* in/out -> "var"
; ppBuffer : CRYPT_PROVIDERS** optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; NTSTATUS BCryptEnumRegisteredProviders(DWORD* pcbBuffer, CRYPT_PROVIDERS** ppBuffer)
#uselib "bcrypt.dll"
#cfunc global BCryptEnumRegisteredProviders "BCryptEnumRegisteredProviders" var, var
; res = BCryptEnumRegisteredProviders(pcbBuffer, ppBuffer)
; pcbBuffer : DWORD* in/out -> "var"
; ppBuffer : CRYPT_PROVIDERS** optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptEnumRegisteredProviders = bcrypt.NewProc("BCryptEnumRegisteredProviders")
)

// pcbBuffer (DWORD* in/out), ppBuffer (CRYPT_PROVIDERS** optional, out)
r1, _, err := procBCryptEnumRegisteredProviders.Call(
	uintptr(pcbBuffer),
	uintptr(ppBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // NTSTATUS
function BCryptEnumRegisteredProviders(
  pcbBuffer: Pointer;   // DWORD* in/out
  ppBuffer: Pointer   // CRYPT_PROVIDERS** optional, out
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptEnumRegisteredProviders';
result := DllCall("bcrypt\BCryptEnumRegisteredProviders"
    , "Ptr", pcbBuffer   ; DWORD* in/out
    , "Ptr", ppBuffer   ; CRYPT_PROVIDERS** optional, out
    , "Int")   ; return: NTSTATUS
●BCryptEnumRegisteredProviders(pcbBuffer, ppBuffer) = DLL("bcrypt.dll", "int BCryptEnumRegisteredProviders(void*, void*)")
# 呼び出し: BCryptEnumRegisteredProviders(pcbBuffer, ppBuffer)
# pcbBuffer : DWORD* in/out -> "void*"
# ppBuffer : CRYPT_PROVIDERS** optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "bcrypt" fn BCryptEnumRegisteredProviders(
    pcbBuffer: [*c]u32, // DWORD* in/out
    ppBuffer: [*c][*c]CRYPT_PROVIDERS // CRYPT_PROVIDERS** optional, out
) callconv(std.os.windows.WINAPI) i32;
proc BCryptEnumRegisteredProviders(
    pcbBuffer: ptr uint32,  # DWORD* in/out
    ppBuffer: ptr CRYPT_PROVIDERS  # CRYPT_PROVIDERS** optional, out
): int32 {.importc: "BCryptEnumRegisteredProviders", stdcall, dynlib: "bcrypt.dll".}
pragma(lib, "bcrypt");
extern(Windows)
int BCryptEnumRegisteredProviders(
    uint* pcbBuffer,   // DWORD* in/out
    CRYPT_PROVIDERS** ppBuffer   // CRYPT_PROVIDERS** optional, out
);
ccall((:BCryptEnumRegisteredProviders, "bcrypt.dll"), stdcall, Int32,
      (Ptr{UInt32}, Ptr{CRYPT_PROVIDERS}),
      pcbBuffer, ppBuffer)
# pcbBuffer : DWORD* in/out -> Ptr{UInt32}
# ppBuffer : CRYPT_PROVIDERS** optional, out -> Ptr{CRYPT_PROVIDERS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BCryptEnumRegisteredProviders(
    uint32_t* pcbBuffer,
    void* ppBuffer);
]]
local bcrypt = ffi.load("bcrypt")
-- bcrypt.BCryptEnumRegisteredProviders(pcbBuffer, ppBuffer)
-- pcbBuffer : DWORD* in/out
-- ppBuffer : CRYPT_PROVIDERS** optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('bcrypt.dll');
const BCryptEnumRegisteredProviders = lib.func('__stdcall', 'BCryptEnumRegisteredProviders', 'int32_t', ['uint32_t *', 'void *']);
// BCryptEnumRegisteredProviders(pcbBuffer, ppBuffer)
// pcbBuffer : DWORD* in/out -> 'uint32_t *'
// ppBuffer : CRYPT_PROVIDERS** optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("bcrypt.dll", {
  BCryptEnumRegisteredProviders: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.BCryptEnumRegisteredProviders(pcbBuffer, ppBuffer)
// pcbBuffer : DWORD* in/out -> "pointer"
// ppBuffer : CRYPT_PROVIDERS** optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BCryptEnumRegisteredProviders(
    uint32_t* pcbBuffer,
    void* ppBuffer);
C, "bcrypt.dll");
// $ffi->BCryptEnumRegisteredProviders(pcbBuffer, ppBuffer);
// pcbBuffer : DWORD* in/out
// ppBuffer : CRYPT_PROVIDERS** optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Bcrypt extends StdCallLibrary {
    Bcrypt INSTANCE = Native.load("bcrypt", Bcrypt.class);
    int BCryptEnumRegisteredProviders(
        IntByReference pcbBuffer,   // DWORD* in/out
        Pointer ppBuffer   // CRYPT_PROVIDERS** optional, out
    );
}
@[Link("bcrypt")]
lib Libbcrypt
  fun BCryptEnumRegisteredProviders = BCryptEnumRegisteredProviders(
    pcbBuffer : UInt32*,   # DWORD* in/out
    ppBuffer : CRYPT_PROVIDERS**   # CRYPT_PROVIDERS** optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BCryptEnumRegisteredProvidersNative = Int32 Function(Pointer<Uint32>, Pointer<Void>);
typedef BCryptEnumRegisteredProvidersDart = int Function(Pointer<Uint32>, Pointer<Void>);
final BCryptEnumRegisteredProviders = DynamicLibrary.open('bcrypt.dll')
    .lookupFunction<BCryptEnumRegisteredProvidersNative, BCryptEnumRegisteredProvidersDart>('BCryptEnumRegisteredProviders');
// pcbBuffer : DWORD* in/out -> Pointer<Uint32>
// ppBuffer : CRYPT_PROVIDERS** optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BCryptEnumRegisteredProviders(
  pcbBuffer: Pointer;   // DWORD* in/out
  ppBuffer: Pointer   // CRYPT_PROVIDERS** optional, out
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptEnumRegisteredProviders';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BCryptEnumRegisteredProviders"
  c_BCryptEnumRegisteredProviders :: Ptr Word32 -> Ptr () -> IO Int32
-- pcbBuffer : DWORD* in/out -> Ptr Word32
-- ppBuffer : CRYPT_PROVIDERS** optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bcryptenumregisteredproviders =
  foreign "BCryptEnumRegisteredProviders"
    ((ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* pcbBuffer : DWORD* in/out -> (ptr uint32_t) *)
(* ppBuffer : CRYPT_PROVIDERS** optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library bcrypt (t "bcrypt.dll"))
(cffi:use-foreign-library bcrypt)

(cffi:defcfun ("BCryptEnumRegisteredProviders" bcrypt-enum-registered-providers :convention :stdcall) :int32
  (pcb-buffer :pointer)   ; DWORD* in/out
  (pp-buffer :pointer))   ; CRYPT_PROVIDERS** optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BCryptEnumRegisteredProviders = Win32::API::More->new('bcrypt',
    'int BCryptEnumRegisteredProviders(LPVOID pcbBuffer, LPVOID ppBuffer)');
# my $ret = $BCryptEnumRegisteredProviders->Call($pcbBuffer, $ppBuffer);
# pcbBuffer : DWORD* in/out -> LPVOID
# ppBuffer : CRYPT_PROVIDERS** optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型