ホーム › System.Diagnostics.Debug › InitializeContext

InitializeContext

関数

バッファ上にコンテキスト構造体を初期化する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL InitializeContext(
    void* Buffer,   // optional
    CONTEXT_FLAGS ContextFlags,
    CONTEXT** Context,
    DWORD* ContextLength
);

パラメーター

名前	型	方向	説明
Buffer	void*	outoptional	CONTEXT 構造体を初期化するバッファへのポインターです。このパラメーターを NULL にすると、指定した ContextFlags を持つコンテキストレコードを保持するために必要なバッファサイズを判定できます。
ContextFlags	CONTEXT_FLAGS	in	Context 構造体のどの部分を初期化するかを示す値です。このパラメーターは、初期化される Context 構造体のサイズに影響します。 Note CONTEXT_XSTATE は CONTEXT_FULL や CONTEXT_ALL に含まれません。XState コンテキストが必要な場合は、個別に指定する必要があります。
Context	CONTEXT**	out	Buffer 内で初期化された CONTEXT 構造体のアドレスを受け取る変数へのポインターです。 Note CONTEXT 構造体のアライメント要件により、 Context に返される値は、指定したバッファの先頭にあるとは限りません。
ContextLength	DWORD*	inout	入力時には、Buffer が指すバッファの長さをバイト単位で指定します。バッファが CONTEXT の指定した部分を格納するのに十分な大きさでない場合、関数は失敗し、GetLastError は ERROR_INSUFFICIENT_BUFFER を返し、ContextLength には必要なバッファサイズが設定されます。ERROR_INSUFFICIENT_BUFFER 以外のエラーで関数が失敗した場合、 ContextLength の内容は未定義です。

戻り値の型: BOOL

公式ドキュメント

必要なサイズとアライメントを持つバッファ内に CONTEXT 構造体を初期化します。

戻り値

この関数は成功すると TRUE を返し、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

InitializeContext は、必要なサイズとアライメント特性を持つバッファ内に CONTEXT 構造体を初期化するために使用できます。必要なコンテキストのサイズとアライメントは、システムで有効になっているプロセッサ機能によって変わる可能性があるため、 CONTEXT_XSTATE ContextFlag を指定する場合はこのルーチンが必要です。

まず、ContextFlags パラメーターに使用する機能の最大数を設定し、 Buffer パラメーターを NULL にしてこの関数を呼び出します。この関数は、必要なバッファサイズをバイト単位で ContextLength パラメーターに返します。Buffer にデータ用の十分な領域を割り当て、再度この関数を呼び出して Context を初期化します。このルーチンが正常に完了すると、 Context 構造体の ContextFlags メンバーが初期化されますが、構造体の残りの内容は未定義です。ContextFlags パラメーターで指定したビットの一部は、システムでサポートされていない場合、Context->ContextFlags に設定されないことがあります。アプリケーションはその後、CONTEXT の ContextFlags メンバーからビットを削除できますが、追加することは決してできません。

SP1 適用済みの Windows 7 および SP1 適用済みの Windows Server 2008 R2: AVX API は、 SP1 適用済みの Windows 7 および SP1 適用済みの Windows Server 2008 R2 で初めて実装されました。SP1 用の SDK が存在しないため、作業に使用できるヘッダーファイルやライブラリファイルがありません。この状況では、呼び出し側はこのドキュメントから必要な関数を宣言し、"Kernel32.dll" に対する GetModuleHandle に続いて GetProcAddress を呼び出して、それらへのポインターを取得する必要があります。詳細については、Working with XState Context を参照してください。

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

各言語での呼び出し定義

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

BOOL InitializeContext(
    void* Buffer,   // optional
    CONTEXT_FLAGS ContextFlags,
    CONTEXT** Context,
    DWORD* ContextLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InitializeContext(
    IntPtr Buffer,   // void* optional, out
    uint ContextFlags,   // CONTEXT_FLAGS
    IntPtr Context,   // CONTEXT** out
    ref uint ContextLength   // DWORD* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InitializeContext(
    Buffer As IntPtr,   ' void* optional, out
    ContextFlags As UInteger,   ' CONTEXT_FLAGS
    Context As IntPtr,   ' CONTEXT** out
    ByRef ContextLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Buffer : void* optional, out
' ContextFlags : CONTEXT_FLAGS
' Context : CONTEXT** out
' ContextLength : DWORD* in/out
Declare PtrSafe Function InitializeContext Lib "kernel32" ( _
    ByVal Buffer As LongPtr, _
    ByVal ContextFlags As Long, _
    ByVal Context As LongPtr, _
    ByRef ContextLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InitializeContext = ctypes.windll.kernel32.InitializeContext
InitializeContext.restype = wintypes.BOOL
InitializeContext.argtypes = [
    ctypes.POINTER(None),  # Buffer : void* optional, out
    wintypes.DWORD,  # ContextFlags : CONTEXT_FLAGS
    ctypes.c_void_p,  # Context : CONTEXT** out
    ctypes.POINTER(wintypes.DWORD),  # ContextLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
InitializeContext = Fiddle::Function.new(
  lib['InitializeContext'],
  [
    Fiddle::TYPE_VOIDP,  # Buffer : void* optional, out
    -Fiddle::TYPE_INT,  # ContextFlags : CONTEXT_FLAGS
    Fiddle::TYPE_VOIDP,  # Context : CONTEXT** out
    Fiddle::TYPE_VOIDP,  # ContextLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn InitializeContext(
        Buffer: *mut (),  // void* optional, out
        ContextFlags: u32,  // CONTEXT_FLAGS
        Context: *mut *mut CONTEXT,  // CONTEXT** out
        ContextLength: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool InitializeContext(IntPtr Buffer, uint ContextFlags, IntPtr Context, ref uint ContextLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_InitializeContext' -Namespace Win32 -PassThru
# $api::InitializeContext(Buffer, ContextFlags, Context, ContextLength)

#uselib "KERNEL32.dll"
#func global InitializeContext "InitializeContext" sptr, sptr, sptr, sptr
; InitializeContext Buffer, ContextFlags, varptr(Context), varptr(ContextLength)   ; 戻り値は stat
; Buffer : void* optional, out -> "sptr"
; ContextFlags : CONTEXT_FLAGS -> "sptr"
; Context : CONTEXT** out -> "sptr"
; ContextLength : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global InitializeContext "InitializeContext" sptr, int, var, var
; res = InitializeContext(Buffer, ContextFlags, Context, ContextLength)
; Buffer : void* optional, out -> "sptr"
; ContextFlags : CONTEXT_FLAGS -> "int"
; Context : CONTEXT** out -> "var"
; ContextLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global InitializeContext "InitializeContext" sptr, int, sptr, sptr
; res = InitializeContext(Buffer, ContextFlags, varptr(Context), varptr(ContextLength))
; Buffer : void* optional, out -> "sptr"
; ContextFlags : CONTEXT_FLAGS -> "int"
; Context : CONTEXT** out -> "sptr"
; ContextLength : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。