ホーム › System.Diagnostics.Debug › GetXStateFeaturesMask

GetXStateFeaturesMask

関数

コンテキスト構造体に設定されているXState機能のマスクを取得する。

DLLKERNEL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

BOOL GetXStateFeaturesMask(
    CONTEXT* Context,
    ULONGLONG* FeatureMask
);

パラメーター

名前	型	方向	説明
Context	CONTEXT*	in	InitializeContext で初期化された CONTEXT 構造体へのポインターです。
FeatureMask	ULONGLONG*	out	指定された CONTEXT 構造体に存在する XState 機能のマスクを受け取る変数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

CONTEXT 構造体内に設定されている XState 機能のマスクを返します。

戻り値

成功した場合、この関数は TRUE を返します。それ以外の場合は FALSE を返します。

解説(Remarks)

GetXStateFeaturesMask 関数は、指定されたコンテキスト内の有効な機能のマスクを返します。CONTEXT を GetThreadContext または Wow64GetThreadContext に渡す場合、アプリケーションは SetXStateFeaturesMask を呼び出して、取得する機能を設定する必要があります。その後、GetThreadContext または Wow64GetThreadContext によって返された CONTEXT に対して GetXStateFeaturesMask を呼び出し、どの機能領域に有効なデータが含まれているかを判断します。特定の機能ビットが設定されていない場合、対応する状態はプロセッサ固有の INITIALIZED 状態にあり、LocateXStateFeature によって取得される機能領域の内容は未定義です。

XState 機能の定義はプロセッサベンダー固有です。特定の機能に関する追加情報については、該当するプロセッサのリファレンスマニュアルを参照してください。

Note コンテキスト操作の後に CONTEXT に対して GetXStateFeaturesMask が返す値は、コンテキスト操作の前に SetXStateFeaturesMask の呼び出しで指定されたマスクのサブセットになります。

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 を参照してください。

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

各言語での呼び出し定義

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

BOOL GetXStateFeaturesMask(
    CONTEXT* Context,
    ULONGLONG* FeatureMask
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool GetXStateFeaturesMask(
    IntPtr Context,   // CONTEXT*
    out ulong FeatureMask   // ULONGLONG* out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetXStateFeaturesMask(
    Context As IntPtr,   ' CONTEXT*
    <Out> ByRef FeatureMask As ULong   ' ULONGLONG* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Context : CONTEXT*
' FeatureMask : ULONGLONG* out
Declare PtrSafe Function GetXStateFeaturesMask Lib "kernel32" ( _
    ByVal Context As LongPtr, _
    ByRef FeatureMask As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetXStateFeaturesMask = ctypes.windll.kernel32.GetXStateFeaturesMask
GetXStateFeaturesMask.restype = wintypes.BOOL
GetXStateFeaturesMask.argtypes = [
    ctypes.c_void_p,  # Context : CONTEXT*
    ctypes.POINTER(ctypes.c_ulonglong),  # FeatureMask : ULONGLONG* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetXStateFeaturesMask = Fiddle::Function.new(
  lib['GetXStateFeaturesMask'],
  [
    Fiddle::TYPE_VOIDP,  # Context : CONTEXT*
    Fiddle::TYPE_VOIDP,  # FeatureMask : ULONGLONG* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetXStateFeaturesMask(
        Context: *mut CONTEXT,  // CONTEXT*
        FeatureMask: *mut u64  // ULONGLONG* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool GetXStateFeaturesMask(IntPtr Context, out ulong FeatureMask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetXStateFeaturesMask' -Namespace Win32 -PassThru
# $api::GetXStateFeaturesMask(Context, FeatureMask)

#uselib "KERNEL32.dll"
#func global GetXStateFeaturesMask "GetXStateFeaturesMask" sptr, sptr
; GetXStateFeaturesMask varptr(Context), varptr(FeatureMask)   ; 戻り値は stat
; Context : CONTEXT* -> "sptr"
; FeatureMask : ULONGLONG* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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