Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Debug › LocateXStateFeature

LocateXStateFeature

関数
コンテキスト内の指定XState機能のデータ位置と長さを取得する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

void* LocateXStateFeature(
    CONTEXT* Context,
    DWORD FeatureId,
    DWORD* Length   // optional
);

パラメーター

名前方向説明
ContextCONTEXT*in取得または設定する状態を格納する CONTEXT 構造体へのポインター。この CONTEXT は、ContextFlags パラメーターに CONTEXT_XSTATE フラグを設定したうえで InitializeContext によって初期化されている必要があります。
FeatureIdDWORDinCONTEXT 構造体内で位置を特定する機能の番号。
LengthDWORD*outoptional機能領域の長さ(バイト単位)を受け取る変数へのポインター。この関数が NULL を返した場合、この変数の内容は未定義です。

戻り値の型: void*

公式ドキュメント

CONTEXT 構造体内の XState 機能に対応するプロセッサ状態へのポインターを取得します。

戻り値

指定した機能がシステムでサポートされており、かつ指定した CONTEXT 構造体が CONTEXT_XSTATE フラグ付きで初期化されている場合、この関数は指定した機能の機能領域へのポインターを返します。この領域の内容とレイアウトはプロセッサ固有です。

CONTEXT 構造体に CONTEXT_XSTATE フラグが設定されていない場合、または FeatureID がシステムでサポートされていない場合、戻り値は NULL になります。追加のエラー情報は提供されません。

解説(Remarks)

拡張可能な CONTEXT 構造体内で個々の XState 機能を見つけるには、LocateXStateFeature 関数を使用する必要があります。機能はメモリ上で必ずしも連続しているとは限らず、アプリケーションは連続する 2 つの機能間のオフセットが将来も一定であると想定してはなりません。

この関数の FeatureID パラメーターは、機能マスク内の 1 ビットに対応します。たとえば、FeatureId 2 は SetXStateFeaturesMask における FeatureMask 4 に対応します。FeatureID 値の 0 と 1 は、それぞれ X87 FPU state と SSE state に対応します。

SetThreadContext または Wow64SetThreadContext API を介してスレッドに XState を設定する場合は、設定した機能をアクティブとしてマークするために、その機能のマスク値を指定して CONTEXT 構造体に対し 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>

void* LocateXStateFeature(
    CONTEXT* Context,
    DWORD FeatureId,
    DWORD* Length   // optional
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern IntPtr LocateXStateFeature(
    IntPtr Context,   // CONTEXT*
    uint FeatureId,   // DWORD
    IntPtr Length   // DWORD* optional, out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function LocateXStateFeature(
    Context As IntPtr,   ' CONTEXT*
    FeatureId As UInteger,   ' DWORD
    Length As IntPtr   ' DWORD* optional, out
) As IntPtr
End Function
' Context : CONTEXT*
' FeatureId : DWORD
' Length : DWORD* optional, out
Declare PtrSafe Function LocateXStateFeature Lib "kernel32" ( _
    ByVal Context As LongPtr, _
    ByVal FeatureId As Long, _
    ByVal Length As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LocateXStateFeature = ctypes.windll.kernel32.LocateXStateFeature
LocateXStateFeature.restype = ctypes.c_void_p
LocateXStateFeature.argtypes = [
    ctypes.c_void_p,  # Context : CONTEXT*
    wintypes.DWORD,  # FeatureId : DWORD
    ctypes.POINTER(wintypes.DWORD),  # Length : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
LocateXStateFeature = Fiddle::Function.new(
  lib['LocateXStateFeature'],
  [
    Fiddle::TYPE_VOIDP,  # Context : CONTEXT*
    -Fiddle::TYPE_INT,  # FeatureId : DWORD
    Fiddle::TYPE_VOIDP,  # Length : DWORD* optional, out
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn LocateXStateFeature(
        Context: *mut CONTEXT,  // CONTEXT*
        FeatureId: u32,  // DWORD
        Length: *mut u32  // DWORD* optional, out
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern IntPtr LocateXStateFeature(IntPtr Context, uint FeatureId, IntPtr Length);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LocateXStateFeature' -Namespace Win32 -PassThru
# $api::LocateXStateFeature(Context, FeatureId, Length)
#uselib "KERNEL32.dll"
#func global LocateXStateFeature "LocateXStateFeature" sptr, sptr, sptr
; LocateXStateFeature varptr(Context), FeatureId, varptr(Length)   ; 戻り値は stat
; Context : CONTEXT* -> "sptr"
; FeatureId : DWORD -> "sptr"
; Length : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global LocateXStateFeature "LocateXStateFeature" var, int, var
; res = LocateXStateFeature(Context, FeatureId, Length)
; Context : CONTEXT* -> "var"
; FeatureId : DWORD -> "int"
; Length : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; void* LocateXStateFeature(CONTEXT* Context, DWORD FeatureId, DWORD* Length)
#uselib "KERNEL32.dll"
#cfunc global LocateXStateFeature "LocateXStateFeature" var, int, var
; res = LocateXStateFeature(Context, FeatureId, Length)
; Context : CONTEXT* -> "var"
; FeatureId : DWORD -> "int"
; Length : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLocateXStateFeature = kernel32.NewProc("LocateXStateFeature")
)

// Context (CONTEXT*), FeatureId (DWORD), Length (DWORD* optional, out)
r1, _, err := procLocateXStateFeature.Call(
	uintptr(Context),
	uintptr(FeatureId),
	uintptr(Length),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void*
function LocateXStateFeature(
  Context: Pointer;   // CONTEXT*
  FeatureId: DWORD;   // DWORD
  Length: Pointer   // DWORD* optional, out
): Pointer; stdcall;
  external 'KERNEL32.dll' name 'LocateXStateFeature';
result := DllCall("KERNEL32\LocateXStateFeature"
    , "Ptr", Context   ; CONTEXT*
    , "UInt", FeatureId   ; DWORD
    , "Ptr", Length   ; DWORD* optional, out
    , "Ptr")   ; return: void*
●LocateXStateFeature(Context, FeatureId, Length) = DLL("KERNEL32.dll", "void* LocateXStateFeature(void*, dword, void*)")
# 呼び出し: LocateXStateFeature(Context, FeatureId, Length)
# Context : CONTEXT* -> "void*"
# FeatureId : DWORD -> "dword"
# Length : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn LocateXStateFeature(
    Context: [*c]CONTEXT, // CONTEXT*
    FeatureId: u32, // DWORD
    Length: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc LocateXStateFeature(
    Context: ptr CONTEXT,  # CONTEXT*
    FeatureId: uint32,  # DWORD
    Length: ptr uint32  # DWORD* optional, out
): pointer {.importc: "LocateXStateFeature", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void* LocateXStateFeature(
    CONTEXT* Context,   // CONTEXT*
    uint FeatureId,   // DWORD
    uint* Length   // DWORD* optional, out
);
ccall((:LocateXStateFeature, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{CONTEXT}, UInt32, Ptr{UInt32}),
      Context, FeatureId, Length)
# Context : CONTEXT* -> Ptr{CONTEXT}
# FeatureId : DWORD -> UInt32
# Length : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* LocateXStateFeature(
    void* Context,
    uint32_t FeatureId,
    uint32_t* Length);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.LocateXStateFeature(Context, FeatureId, Length)
-- Context : CONTEXT*
-- FeatureId : DWORD
-- Length : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const LocateXStateFeature = lib.func('__stdcall', 'LocateXStateFeature', 'void *', ['void *', 'uint32_t', 'uint32_t *']);
// LocateXStateFeature(Context, FeatureId, Length)
// Context : CONTEXT* -> 'void *'
// FeatureId : DWORD -> 'uint32_t'
// Length : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  LocateXStateFeature: { parameters: ["pointer", "u32", "pointer"], result: "pointer" },
});
// lib.symbols.LocateXStateFeature(Context, FeatureId, Length)
// Context : CONTEXT* -> "pointer"
// FeatureId : DWORD -> "u32"
// Length : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* LocateXStateFeature(
    void* Context,
    uint32_t FeatureId,
    uint32_t* Length);
C, "KERNEL32.dll");
// $ffi->LocateXStateFeature(Context, FeatureId, Length);
// Context : CONTEXT*
// FeatureId : DWORD
// Length : DWORD* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    Pointer LocateXStateFeature(
        Pointer Context,   // CONTEXT*
        int FeatureId,   // DWORD
        IntByReference Length   // DWORD* optional, out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun LocateXStateFeature = LocateXStateFeature(
    Context : CONTEXT*,   # CONTEXT*
    FeatureId : UInt32,   # DWORD
    Length : UInt32*   # DWORD* optional, out
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LocateXStateFeatureNative = Pointer<Void> Function(Pointer<Void>, Uint32, Pointer<Uint32>);
typedef LocateXStateFeatureDart = Pointer<Void> Function(Pointer<Void>, int, Pointer<Uint32>);
final LocateXStateFeature = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<LocateXStateFeatureNative, LocateXStateFeatureDart>('LocateXStateFeature');
// Context : CONTEXT* -> Pointer<Void>
// FeatureId : DWORD -> Uint32
// Length : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LocateXStateFeature(
  Context: Pointer;   // CONTEXT*
  FeatureId: DWORD;   // DWORD
  Length: Pointer   // DWORD* optional, out
): Pointer; stdcall;
  external 'KERNEL32.dll' name 'LocateXStateFeature';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LocateXStateFeature"
  c_LocateXStateFeature :: Ptr () -> Word32 -> Ptr Word32 -> IO (Ptr ())
-- Context : CONTEXT* -> Ptr ()
-- FeatureId : DWORD -> Word32
-- Length : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let locatexstatefeature =
  foreign "LocateXStateFeature"
    ((ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning (ptr void))
(* Context : CONTEXT* -> (ptr void) *)
(* FeatureId : DWORD -> uint32_t *)
(* Length : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("LocateXStateFeature" locate-xstate-feature :convention :stdcall) :pointer
  (context :pointer)   ; CONTEXT*
  (feature-id :uint32)   ; DWORD
  (length :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LocateXStateFeature = Win32::API::More->new('KERNEL32',
    'LPVOID LocateXStateFeature(LPVOID Context, DWORD FeatureId, LPVOID Length)');
# my $ret = $LocateXStateFeature->Call($Context, $FeatureId, $Length);
# Context : CONTEXT* -> LPVOID
# FeatureId : DWORD -> DWORD
# Length : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型