ホーム › Security.Cryptography › BCryptEnumContexts

BCryptEnumContexts

関数

CNG構成テーブル内のコンテキストを列挙して取得する。

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

シグネチャ

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

NTSTATUS BCryptEnumContexts(
    BCRYPT_TABLE dwTable,
    DWORD* pcbBuffer,
    CRYPT_CONTEXTS** ppBuffer   // optional
);

パラメーター

名前

型

方向

説明

dwTable

BCRYPT_TABLE

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

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

pcbBuffer

DWORD*

inout

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

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

ppBuffer

CRYPT_CONTEXTS**

outoptional

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

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

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

戻り値の型: NTSTATUS

公式ドキュメント

指定された構成テーブル内のコンテキストの識別子を取得します。

戻り値

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

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

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

解説(Remarks)

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

例

次の例は、BCryptEnumContexts 関数を使用して ppBuffer バッファのメモリを割り当てる方法を示しています。

#ifndef NT_SUCCESS
#define NT_SUCCESS(Status) ((NTSTATUS)(Status) >= 0)
#endif

NTSTATUS EnumContexts_SystemAlloc()
{
    NTSTATUS status;
    ULONG uSize = 0;
    PCRYPT_CONTEXTS pContexts = NULL;
    
    // Get the contexts for the local computer. 
    // CNG allocates the memory.
    status = BCryptEnumContexts(CRYPT_LOCAL, &uSize, &pContexts);
    if(NT_SUCCESS(status))
    {
        // Enumerate the context identifiers.
        for(ULONG i = 0; i < pContexts->cContexts; i++)
        {
            wprintf(pContexts->rgpszContexts[i]);
            wprintf(L"\n");
        }

        // Free the buffer.
        BCryptFreeBuffer(pContexts);
    }

    return status;
}

次の例は、BCryptEnumContexts 関数を使用して ppBuffer バッファのメモリを自分で割り当てる方法を示しています。

#ifndef NT_SUCCESS
#define NT_SUCCESS(Status) ((NTSTATUS)(Status) >= 0)
#endif

NTSTATUS EnumContexts_SelfAlloc()
{
    NTSTATUS status;
    ULONG uSize = 0;
    
    // Get the required size of the buffer.
    status = BCryptEnumContexts(CRYPT_LOCAL, &uSize, NULL);
    if(STATUS_BUFFER_TOO_SMALL == status)
    {
        // Allocate the buffer.
        PCRYPT_CONTEXTS pContexts = (PCRYPT_CONTEXTS)HeapAlloc(
            GetProcessHeap(), 
            HEAP_ZERO_MEMORY, 
            uSize);
        if(pContexts)
        {
            // Get the contexts for the local machine.
            status = BCryptEnumContexts(
                CRYPT_LOCAL, 
                &uSize, 
                &pContexts);
            if(NT_SUCCESS((status))
            {
                // Enumerate the context identifiers.
                for(ULONG i = 0; i < pContexts->cContexts; i++)
                {
                    wprintf(pContexts->rgpszContexts[i]);
                    wprintf(L"\n");
                }
            }

            // Free the buffer.
            HeapFree(GetProcessHeap(), 0, pContexts);
            pContexts = NULL;
        }
        else
        {
            status = STATUS_NO_MEMORY;
        }
    }

    return status;
}

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

各言語での呼び出し定義

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

NTSTATUS BCryptEnumContexts(
    BCRYPT_TABLE dwTable,
    DWORD* pcbBuffer,
    CRYPT_CONTEXTS** ppBuffer   // optional
);

[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptEnumContexts(
    uint dwTable,   // BCRYPT_TABLE
    ref uint pcbBuffer,   // DWORD* in/out
    IntPtr ppBuffer   // CRYPT_CONTEXTS** optional, out
);

<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptEnumContexts(
    dwTable As UInteger,   ' BCRYPT_TABLE
    ByRef pcbBuffer As UInteger,   ' DWORD* in/out
    ppBuffer As IntPtr   ' CRYPT_CONTEXTS** optional, out
) As Integer
End Function

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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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