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

CryptGetDefaultOIDDllList

関数
OID関数の既定DLLの一覧を取得する。
DLLCRYPT32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CryptGetDefaultOIDDllList(
    void* hFuncSet,
    DWORD dwEncodingType,
    LPWSTR pwszDllList,   // optional
    DWORD* pcchDllList
);

パラメーター

名前方向説明
hFuncSetvoid*inCryptInitOIDFunctionSet の呼び出しによって事前に取得された関数セットのハンドルです。
dwEncodingTypeDWORDin

照合対象とするエンコーディング種別を指定します。現在使用されているのは X509_ASN_ENCODINGPKCS_7_ASN_ENCODING のみですが、今後さらにエンコーディング種別が追加される可能性があります。現在の両方のエンコーディング種別を照合するには、次を使用します。

X509_ASN_ENCODING | PKCS_7_ASN_ENCODING

注意 証明書またはメッセージエンコーディング種別のいずれかが必要です。既定は X509_ASN_ENCODING です。この種別が指定されている場合はそれが使用され、指定されていない場合は PKCS7_ASN_ENCODING 種別が指定されていればそれが使用されます。
pwszDllListLPWSTRoutoptional

0 個以上の null 終端されたファイル名の一覧を受け取るバッファーへのポインターです。返される一覧は終端の NULL 文字で終わります。たとえば、2 つの名前の一覧は次のようになります。

L"first.dll\0" L"second.dll\0" L"\0"

バッファーが保持すべきワイド文字数を取得するには、このパラメーターを NULL にできます。詳細については、長さが不明なデータの取得を参照してください。

pcchDllListDWORD*inout

pwszDllList パラメーターが指す返される一覧のサイズをワイド文字単位で指定する DWORD へのポインターです。関数が戻るとき、pcchDllList パラメーターが指す変数には、バッファーに格納されたワイド文字数が含まれます。

注意 バッファーに返されたデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなる場合があります。入力時には、想定される最大の出力データが収まるよう、通常はバッファーサイズを十分大きく指定します。出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するよう更新されます。

戻り値の型: BOOL

公式ドキュメント

CryptGetDefaultOIDDllList 関数は、指定された関数セットおよびエンコーディング種別に対して登録されている既定のオブジェクト識別子 (OID) 関数を含む DLL ファイルの名前一覧を取得します。

戻り値

関数が成功した場合は、0 以外の値 (TRUE) を返します。

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

この関数には次のエラーコードがあります。

戻り値 説明
ERROR_MORE_DATA
pwszDllList パラメーターで指定したバッファーが、返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズをワイド文字単位で pcchDllList が指す変数に格納します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL CryptGetDefaultOIDDllList(
    void* hFuncSet,
    DWORD dwEncodingType,
    LPWSTR pwszDllList,   // optional
    DWORD* pcchDllList
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptGetDefaultOIDDllList(
    IntPtr hFuncSet,   // void*
    uint dwEncodingType,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszDllList,   // LPWSTR optional, out
    ref uint pcchDllList   // DWORD* in/out
);
<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptGetDefaultOIDDllList(
    hFuncSet As IntPtr,   ' void*
    dwEncodingType As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pwszDllList As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchDllList As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hFuncSet : void*
' dwEncodingType : DWORD
' pwszDllList : LPWSTR optional, out
' pcchDllList : DWORD* in/out
Declare PtrSafe Function CryptGetDefaultOIDDllList Lib "crypt32" ( _
    ByVal hFuncSet As LongPtr, _
    ByVal dwEncodingType As Long, _
    ByVal pwszDllList As LongPtr, _
    ByRef pcchDllList As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CryptGetDefaultOIDDllList = ctypes.windll.crypt32.CryptGetDefaultOIDDllList
CryptGetDefaultOIDDllList.restype = wintypes.BOOL
CryptGetDefaultOIDDllList.argtypes = [
    ctypes.POINTER(None),  # hFuncSet : void*
    wintypes.DWORD,  # dwEncodingType : DWORD
    wintypes.LPWSTR,  # pwszDllList : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchDllList : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptGetDefaultOIDDllList = Fiddle::Function.new(
  lib['CryptGetDefaultOIDDllList'],
  [
    Fiddle::TYPE_VOIDP,  # hFuncSet : void*
    -Fiddle::TYPE_INT,  # dwEncodingType : DWORD
    Fiddle::TYPE_VOIDP,  # pwszDllList : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchDllList : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "crypt32")]
extern "system" {
    fn CryptGetDefaultOIDDllList(
        hFuncSet: *mut (),  // void*
        dwEncodingType: u32,  // DWORD
        pwszDllList: *mut u16,  // LPWSTR optional, out
        pcchDllList: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern bool CryptGetDefaultOIDDllList(IntPtr hFuncSet, uint dwEncodingType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszDllList, ref uint pcchDllList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptGetDefaultOIDDllList' -Namespace Win32 -PassThru
# $api::CryptGetDefaultOIDDllList(hFuncSet, dwEncodingType, pwszDllList, pcchDllList)
#uselib "CRYPT32.dll"
#func global CryptGetDefaultOIDDllList "CryptGetDefaultOIDDllList" sptr, sptr, sptr, sptr
; CryptGetDefaultOIDDllList hFuncSet, dwEncodingType, varptr(pwszDllList), varptr(pcchDllList)   ; 戻り値は stat
; hFuncSet : void* -> "sptr"
; dwEncodingType : DWORD -> "sptr"
; pwszDllList : LPWSTR optional, out -> "sptr"
; pcchDllList : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CRYPT32.dll"
#cfunc global CryptGetDefaultOIDDllList "CryptGetDefaultOIDDllList" sptr, int, var, var
; res = CryptGetDefaultOIDDllList(hFuncSet, dwEncodingType, pwszDllList, pcchDllList)
; hFuncSet : void* -> "sptr"
; dwEncodingType : DWORD -> "int"
; pwszDllList : LPWSTR optional, out -> "var"
; pcchDllList : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CryptGetDefaultOIDDllList(void* hFuncSet, DWORD dwEncodingType, LPWSTR pwszDllList, DWORD* pcchDllList)
#uselib "CRYPT32.dll"
#cfunc global CryptGetDefaultOIDDllList "CryptGetDefaultOIDDllList" intptr, int, var, var
; res = CryptGetDefaultOIDDllList(hFuncSet, dwEncodingType, pwszDllList, pcchDllList)
; hFuncSet : void* -> "intptr"
; dwEncodingType : DWORD -> "int"
; pwszDllList : LPWSTR optional, out -> "var"
; pcchDllList : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	crypt32 = windows.NewLazySystemDLL("CRYPT32.dll")
	procCryptGetDefaultOIDDllList = crypt32.NewProc("CryptGetDefaultOIDDllList")
)

// hFuncSet (void*), dwEncodingType (DWORD), pwszDllList (LPWSTR optional, out), pcchDllList (DWORD* in/out)
r1, _, err := procCryptGetDefaultOIDDllList.Call(
	uintptr(hFuncSet),
	uintptr(dwEncodingType),
	uintptr(pwszDllList),
	uintptr(pcchDllList),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CryptGetDefaultOIDDllList(
  hFuncSet: Pointer;   // void*
  dwEncodingType: DWORD;   // DWORD
  pwszDllList: PWideChar;   // LPWSTR optional, out
  pcchDllList: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CryptGetDefaultOIDDllList';
result := DllCall("CRYPT32\CryptGetDefaultOIDDllList"
    , "Ptr", hFuncSet   ; void*
    , "UInt", dwEncodingType   ; DWORD
    , "Ptr", pwszDllList   ; LPWSTR optional, out
    , "Ptr", pcchDllList   ; DWORD* in/out
    , "Int")   ; return: BOOL
●CryptGetDefaultOIDDllList(hFuncSet, dwEncodingType, pwszDllList, pcchDllList) = DLL("CRYPT32.dll", "bool CryptGetDefaultOIDDllList(void*, dword, char*, void*)")
# 呼び出し: CryptGetDefaultOIDDllList(hFuncSet, dwEncodingType, pwszDllList, pcchDllList)
# hFuncSet : void* -> "void*"
# dwEncodingType : DWORD -> "dword"
# pwszDllList : LPWSTR optional, out -> "char*"
# pcchDllList : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "crypt32" fn CryptGetDefaultOIDDllList(
    hFuncSet: ?*anyopaque, // void*
    dwEncodingType: u32, // DWORD
    pwszDllList: [*c]u16, // LPWSTR optional, out
    pcchDllList: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
proc CryptGetDefaultOIDDllList(
    hFuncSet: pointer,  # void*
    dwEncodingType: uint32,  # DWORD
    pwszDllList: ptr uint16,  # LPWSTR optional, out
    pcchDllList: ptr uint32  # DWORD* in/out
): int32 {.importc: "CryptGetDefaultOIDDllList", stdcall, dynlib: "CRYPT32.dll".}
pragma(lib, "crypt32");
extern(Windows)
int CryptGetDefaultOIDDllList(
    void* hFuncSet,   // void*
    uint dwEncodingType,   // DWORD
    wchar* pwszDllList,   // LPWSTR optional, out
    uint* pcchDllList   // DWORD* in/out
);
ccall((:CryptGetDefaultOIDDllList, "CRYPT32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{UInt16}, Ptr{UInt32}),
      hFuncSet, dwEncodingType, pwszDllList, pcchDllList)
# hFuncSet : void* -> Ptr{Cvoid}
# dwEncodingType : DWORD -> UInt32
# pwszDllList : LPWSTR optional, out -> Ptr{UInt16}
# pcchDllList : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CryptGetDefaultOIDDllList(
    void* hFuncSet,
    uint32_t dwEncodingType,
    uint16_t* pwszDllList,
    uint32_t* pcchDllList);
]]
local crypt32 = ffi.load("crypt32")
-- crypt32.CryptGetDefaultOIDDllList(hFuncSet, dwEncodingType, pwszDllList, pcchDllList)
-- hFuncSet : void*
-- dwEncodingType : DWORD
-- pwszDllList : LPWSTR optional, out
-- pcchDllList : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CRYPT32.dll');
const CryptGetDefaultOIDDllList = lib.func('__stdcall', 'CryptGetDefaultOIDDllList', 'int32_t', ['void *', 'uint32_t', 'uint16_t *', 'uint32_t *']);
// CryptGetDefaultOIDDllList(hFuncSet, dwEncodingType, pwszDllList, pcchDllList)
// hFuncSet : void* -> 'void *'
// dwEncodingType : DWORD -> 'uint32_t'
// pwszDllList : LPWSTR optional, out -> 'uint16_t *'
// pcchDllList : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CRYPT32.dll", {
  CryptGetDefaultOIDDllList: { parameters: ["pointer", "u32", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.CryptGetDefaultOIDDllList(hFuncSet, dwEncodingType, pwszDllList, pcchDllList)
// hFuncSet : void* -> "pointer"
// dwEncodingType : DWORD -> "u32"
// pwszDllList : LPWSTR optional, out -> "buffer"
// pcchDllList : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CryptGetDefaultOIDDllList(
    void* hFuncSet,
    uint32_t dwEncodingType,
    uint16_t* pwszDllList,
    uint32_t* pcchDllList);
C, "CRYPT32.dll");
// $ffi->CryptGetDefaultOIDDllList(hFuncSet, dwEncodingType, pwszDllList, pcchDllList);
// hFuncSet : void*
// dwEncodingType : DWORD
// pwszDllList : LPWSTR optional, out
// pcchDllList : DWORD* in/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 Crypt32 extends StdCallLibrary {
    Crypt32 INSTANCE = Native.load("crypt32", Crypt32.class);
    boolean CryptGetDefaultOIDDllList(
        Pointer hFuncSet,   // void*
        int dwEncodingType,   // DWORD
        char[] pwszDllList,   // LPWSTR optional, out
        IntByReference pcchDllList   // DWORD* in/out
    );
}
@[Link("crypt32")]
lib LibCRYPT32
  fun CryptGetDefaultOIDDllList = CryptGetDefaultOIDDllList(
    hFuncSet : Void*,   # void*
    dwEncodingType : UInt32,   # DWORD
    pwszDllList : UInt16*,   # LPWSTR optional, out
    pcchDllList : UInt32*   # DWORD* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CryptGetDefaultOIDDllListNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef CryptGetDefaultOIDDllListDart = int Function(Pointer<Void>, int, Pointer<Utf16>, Pointer<Uint32>);
final CryptGetDefaultOIDDllList = DynamicLibrary.open('CRYPT32.dll')
    .lookupFunction<CryptGetDefaultOIDDllListNative, CryptGetDefaultOIDDllListDart>('CryptGetDefaultOIDDllList');
// hFuncSet : void* -> Pointer<Void>
// dwEncodingType : DWORD -> Uint32
// pwszDllList : LPWSTR optional, out -> Pointer<Utf16>
// pcchDllList : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CryptGetDefaultOIDDllList(
  hFuncSet: Pointer;   // void*
  dwEncodingType: DWORD;   // DWORD
  pwszDllList: PWideChar;   // LPWSTR optional, out
  pcchDllList: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CryptGetDefaultOIDDllList';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CryptGetDefaultOIDDllList"
  c_CryptGetDefaultOIDDllList :: Ptr () -> Word32 -> CWString -> Ptr Word32 -> IO CInt
-- hFuncSet : void* -> Ptr ()
-- dwEncodingType : DWORD -> Word32
-- pwszDllList : LPWSTR optional, out -> CWString
-- pcchDllList : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cryptgetdefaultoiddlllist =
  foreign "CryptGetDefaultOIDDllList"
    ((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* hFuncSet : void* -> (ptr void) *)
(* dwEncodingType : DWORD -> uint32_t *)
(* pwszDllList : LPWSTR optional, out -> (ptr uint16_t) *)
(* pcchDllList : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library crypt32 (t "CRYPT32.dll"))
(cffi:use-foreign-library crypt32)

(cffi:defcfun ("CryptGetDefaultOIDDllList" crypt-get-default-oiddll-list :convention :stdcall) :int32
  (h-func-set :pointer)   ; void*
  (dw-encoding-type :uint32)   ; DWORD
  (pwsz-dll-list :pointer)   ; LPWSTR optional, out
  (pcch-dll-list :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CryptGetDefaultOIDDllList = Win32::API::More->new('CRYPT32',
    'BOOL CryptGetDefaultOIDDllList(LPVOID hFuncSet, DWORD dwEncodingType, LPWSTR pwszDllList, LPVOID pcchDllList)');
# my $ret = $CryptGetDefaultOIDDllList->Call($hFuncSet, $dwEncodingType, $pwszDllList, $pcchDllList);
# hFuncSet : void* -> LPVOID
# dwEncodingType : DWORD -> DWORD
# pwszDllList : LPWSTR optional, out -> LPWSTR
# pcchDllList : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。