ホーム › Security.Cryptography › BCryptQueryContextConfiguration

BCryptQueryContextConfiguration

関数

指定したCNGコンテキストの構成情報を取得する。

DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptQueryContextConfiguration(
    BCRYPT_TABLE dwTable,
    LPCWSTR pszContext,
    DWORD* pcbBuffer,
    CRYPT_CONTEXT_CONFIG** ppBuffer   // optional
);

パラメーター

名前

型

方向

説明

dwTable

BCRYPT_TABLE

コンテキストが存在する構成テーブルを識別します。次のいずれかの値を指定できます。

値	意味
CRYPT_LOCAL	コンテキストはローカルマシンの構成テーブルに存在します。
CRYPT_DOMAIN	この値は使用できません。

pszContext

LPCWSTR

構成情報を取得する対象のコンテキストの識別子を含む、null で終わる Unicode 文字列へのポインターです。

pcbBuffer

DWORD*

inout

ULONG 変数のアドレスです。呼び出し時には、ppBuffer が指すバッファーのサイズ(バイト単位)を格納します。このサイズがコンテキスト情報を保持するのに十分でない場合、この関数は STATUS_BUFFER_TOO_SMALL で失敗します。

この関数が返った後、この変数には ppBuffer バッファーにコピーされたバイト数が格納されます。

ppBuffer

CRYPT_CONTEXT_CONFIG**

outoptional

この関数が取得したコンテキスト構成情報を受け取る CRYPT_CONTEXT_CONFIG 構造体へのポインターのアドレスです。pcbBuffer パラメーターが指す値には、このバッファーのサイズが格納されます。

このパラメーターが指す値が NULL の場合、この関数は必要なメモリを割り当てます。このメモリは不要になった時点で、このポインターを BCryptFreeBuffer 関数に渡して解放する必要があります。

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

このパラメーターの使用方法の詳細については、「解説」を参照してください。

戻り値の型: NTSTATUS

公式ドキュメント

指定された CNG コンテキストの現在の構成を取得します。

戻り値

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

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

戻り値	説明
STATUS_SUCCESS	関数は成功しました。
STATUS_BUFFER_TOO_SMALL	ppBuffer パラメーターが NULL ではなく、かつ pcbBuffer パラメーターが指す値がコンテキストのセットを保持するのに十分な大きさではありません。
STATUS_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
STATUS_NO_MEMORY	メモリの割り当てに失敗しました。
STATUS_NOT_FOUND	指定されたコンテキストが見つかりませんでした。

解説(Remarks)

各コンテキストは構成情報のセットを 1 つだけ持つため、ppBuffer パラメーターは配列として使用されるように見えますが、この関数はこれを要素が 1 つだけの配列として扱います。次の例は、このパラメーターの使用方法を明確にするのに役立ちます。

// コンテキストの構成情報を取得します。
CRYPT_CONTEXT_CONFIG config;
ULONG uSize = sizeof(config);
PCRYPT_CONTEXT_CONFIG pConfig = &config;
status = BCryptQueryContextConfiguration(
    CRYPT_LOCAL, 
    pszContextID, 
    &uSize, 
    &pConfig);

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

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

各言語での呼び出し定義

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

NTSTATUS BCryptQueryContextConfiguration(
    BCRYPT_TABLE dwTable,
    LPCWSTR pszContext,
    DWORD* pcbBuffer,
    CRYPT_CONTEXT_CONFIG** ppBuffer   // optional
);

[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptQueryContextConfiguration(
    uint dwTable,   // BCRYPT_TABLE
    [MarshalAs(UnmanagedType.LPWStr)] string pszContext,   // LPCWSTR
    ref uint pcbBuffer,   // DWORD* in/out
    IntPtr ppBuffer   // CRYPT_CONTEXT_CONFIG** optional, out
);

<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptQueryContextConfiguration(
    dwTable As UInteger,   ' BCRYPT_TABLE
    <MarshalAs(UnmanagedType.LPWStr)> pszContext As String,   ' LPCWSTR
    ByRef pcbBuffer As UInteger,   ' DWORD* in/out
    ppBuffer As IntPtr   ' CRYPT_CONTEXT_CONFIG** optional, out
) As Integer
End Function

' dwTable : BCRYPT_TABLE
' pszContext : LPCWSTR
' pcbBuffer : DWORD* in/out
' ppBuffer : CRYPT_CONTEXT_CONFIG** optional, out
Declare PtrSafe Function BCryptQueryContextConfiguration Lib "bcrypt" ( _
    ByVal dwTable As Long, _
    ByVal pszContext As LongPtr, _
    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

BCryptQueryContextConfiguration = ctypes.windll.bcrypt.BCryptQueryContextConfiguration
BCryptQueryContextConfiguration.restype = ctypes.c_int
BCryptQueryContextConfiguration.argtypes = [
    wintypes.DWORD,  # dwTable : BCRYPT_TABLE
    wintypes.LPCWSTR,  # pszContext : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # pcbBuffer : DWORD* in/out
    ctypes.c_void_p,  # ppBuffer : CRYPT_CONTEXT_CONFIG** optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptQueryContextConfiguration = Fiddle::Function.new(
  lib['BCryptQueryContextConfiguration'],
  [
    -Fiddle::TYPE_INT,  # dwTable : BCRYPT_TABLE
    Fiddle::TYPE_VOIDP,  # pszContext : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pcbBuffer : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ppBuffer : CRYPT_CONTEXT_CONFIG** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "bcrypt")]
extern "system" {
    fn BCryptQueryContextConfiguration(
        dwTable: u32,  // BCRYPT_TABLE
        pszContext: *const u16,  // LPCWSTR
        pcbBuffer: *mut u32,  // DWORD* in/out
        ppBuffer: *mut *mut CRYPT_CONTEXT_CONFIG  // CRYPT_CONTEXT_CONFIG** optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptQueryContextConfiguration(uint dwTable, [MarshalAs(UnmanagedType.LPWStr)] string pszContext, ref uint pcbBuffer, IntPtr ppBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptQueryContextConfiguration' -Namespace Win32 -PassThru
# $api::BCryptQueryContextConfiguration(dwTable, pszContext, pcbBuffer, ppBuffer)

#uselib "bcrypt.dll"
#func global BCryptQueryContextConfiguration "BCryptQueryContextConfiguration" sptr, sptr, sptr, sptr
; BCryptQueryContextConfiguration dwTable, pszContext, varptr(pcbBuffer), varptr(ppBuffer)   ; 戻り値は stat
; dwTable : BCRYPT_TABLE -> "sptr"
; pszContext : LPCWSTR -> "sptr"
; pcbBuffer : DWORD* in/out -> "sptr"
; ppBuffer : CRYPT_CONTEXT_CONFIG** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "bcrypt.dll"
#cfunc global BCryptQueryContextConfiguration "BCryptQueryContextConfiguration" int, wstr, var, var
; res = BCryptQueryContextConfiguration(dwTable, pszContext, pcbBuffer, ppBuffer)
; dwTable : BCRYPT_TABLE -> "int"
; pszContext : LPCWSTR -> "wstr"
; pcbBuffer : DWORD* in/out -> "var"
; ppBuffer : CRYPT_CONTEXT_CONFIG** optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "bcrypt.dll"
#cfunc global BCryptQueryContextConfiguration "BCryptQueryContextConfiguration" int, wstr, sptr, sptr
; res = BCryptQueryContextConfiguration(dwTable, pszContext, varptr(pcbBuffer), varptr(ppBuffer))
; dwTable : BCRYPT_TABLE -> "int"
; pszContext : LPCWSTR -> "wstr"
; pcbBuffer : DWORD* in/out -> "sptr"
; ppBuffer : CRYPT_CONTEXT_CONFIG** optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。