ホーム › System.Diagnostics.Debug › InitializeContext2

InitializeContext2

関数

XStateの圧縮マスクを指定して、スレッドコンテキスト構造体をバッファ内に初期化する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

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

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

必要なサイズとアラインメントを備えたバッファ内に CONTEXT 構造体を初期化します。XSTATE のコンパクションマスクを指定するオプションがあります。

戻り値

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

解説(Remarks)

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

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

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

XState がコンパクションモードで有効になっている場合、有効な XState コンポーネントのサブセットのみを含む XStateCompactionMask を指定すると、Context の格納に必要なバッファサイズを削減できます。これは、システムで多数の XState コンポーネントが有効になっているが、Context がごく少数の XState コンポーネントにのみ作用する場合に特に有用です。有効な XState コンポーネントの完全なセットは、GetEnabledXStateFeatures を呼び出すことで取得できます。この関数は、指定された XState コンパクションマスクを XState ヘッダー内の該当する場所にコピーします。

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

各言語での呼び出し定義

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

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

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

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

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

import ctypes
from ctypes import wintypes

InitializeContext2 = ctypes.windll.kernel32.InitializeContext2
InitializeContext2.restype = wintypes.BOOL
InitializeContext2.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
    ctypes.c_ulonglong,  # XStateCompactionMask : ULONGLONG
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
InitializeContext2 = Fiddle::Function.new(
  lib['InitializeContext2'],
  [
    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_LONG_LONG,  # XStateCompactionMask : ULONGLONG
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn InitializeContext2(
        Buffer: *mut (),  // void* optional, out
        ContextFlags: u32,  // CONTEXT_FLAGS
        Context: *mut *mut CONTEXT,  // CONTEXT** out
        ContextLength: *mut u32,  // DWORD* in/out
        XStateCompactionMask: u64  // ULONGLONG
    ) -> 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 InitializeContext2(IntPtr Buffer, uint ContextFlags, IntPtr Context, ref uint ContextLength, ulong XStateCompactionMask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_InitializeContext2' -Namespace Win32 -PassThru
# $api::InitializeContext2(Buffer, ContextFlags, Context, ContextLength, XStateCompactionMask)

#uselib "KERNEL32.dll"
#func global InitializeContext2 "InitializeContext2" sptr, sptr, sptr, sptr, sptr
; InitializeContext2 Buffer, ContextFlags, varptr(Context), varptr(ContextLength), XStateCompactionMask   ; 戻り値は stat
; Buffer : void* optional, out -> "sptr"
; ContextFlags : CONTEXT_FLAGS -> "sptr"
; Context : CONTEXT** out -> "sptr"
; ContextLength : DWORD* in/out -> "sptr"
; XStateCompactionMask : ULONGLONG -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global InitializeContext2 "InitializeContext2" sptr, int, var, var, int64
; res = InitializeContext2(Buffer, ContextFlags, Context, ContextLength, XStateCompactionMask)
; Buffer : void* optional, out -> "sptr"
; ContextFlags : CONTEXT_FLAGS -> "int"
; Context : CONTEXT** out -> "var"
; ContextLength : DWORD* in/out -> "var"
; XStateCompactionMask : ULONGLONG -> "int64"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "KERNEL32.dll"
#cfunc global InitializeContext2 "InitializeContext2" sptr, int, sptr, sptr, int64
; res = InitializeContext2(Buffer, ContextFlags, varptr(Context), varptr(ContextLength), XStateCompactionMask)
; Buffer : void* optional, out -> "sptr"
; ContextFlags : CONTEXT_FLAGS -> "int"
; Context : CONTEXT** out -> "sptr"
; ContextLength : DWORD* in/out -> "sptr"
; XStateCompactionMask : ULONGLONG -> "int64"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。