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

SetXStateFeaturesMask

関数
コンテキスト構造体に保存するXState機能のマスクを設定する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

BOOL SetXStateFeaturesMask(
    CONTEXT* Context,
    ULONGLONG FeatureMask
);

パラメーター

名前方向説明
ContextCONTEXT*inoutInitializeContext で初期化された CONTEXT 構造体へのポインターです。
FeatureMaskULONGLONGin指定した CONTEXT 構造体に設定する XState 機能のマスクです。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

この関数は成功した場合は TRUE を返し、そうでない場合は FALSE を返します。

解説(Remarks)

SetXStateFeaturesMask 関数は、指定したコンテキスト内の有効な機能のマスクを設定します。GetThreadContextWow64GetThreadContextSetThreadContext、または Wow64SetThreadContext を呼び出す前に、アプリケーションは SetXStateFeaturesMask を呼び出して、取得または設定する機能のセットを指定する必要があります。システムは、プロセッサで有効になっていない機能が FeatureMask に指定されている場合、それを暗黙的に無視します。

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 SetXStateFeaturesMask(
    CONTEXT* Context,
    ULONGLONG FeatureMask
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool SetXStateFeaturesMask(
    IntPtr Context,   // CONTEXT* in/out
    ulong FeatureMask   // ULONGLONG
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function SetXStateFeaturesMask(
    Context As IntPtr,   ' CONTEXT* in/out
    FeatureMask As ULong   ' ULONGLONG
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Context : CONTEXT* in/out
' FeatureMask : ULONGLONG
Declare PtrSafe Function SetXStateFeaturesMask Lib "kernel32" ( _
    ByVal Context As LongPtr, _
    ByVal FeatureMask As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetXStateFeaturesMask = ctypes.windll.kernel32.SetXStateFeaturesMask
SetXStateFeaturesMask.restype = wintypes.BOOL
SetXStateFeaturesMask.argtypes = [
    ctypes.c_void_p,  # Context : CONTEXT* in/out
    ctypes.c_ulonglong,  # FeatureMask : ULONGLONG
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetXStateFeaturesMask = Fiddle::Function.new(
  lib['SetXStateFeaturesMask'],
  [
    Fiddle::TYPE_VOIDP,  # Context : CONTEXT* in/out
    -Fiddle::TYPE_LONG_LONG,  # FeatureMask : ULONGLONG
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetXStateFeaturesMask(
        Context: *mut CONTEXT,  // CONTEXT* in/out
        FeatureMask: u64  // ULONGLONG
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool SetXStateFeaturesMask(IntPtr Context, ulong FeatureMask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetXStateFeaturesMask' -Namespace Win32 -PassThru
# $api::SetXStateFeaturesMask(Context, FeatureMask)
#uselib "KERNEL32.dll"
#func global SetXStateFeaturesMask "SetXStateFeaturesMask" sptr, sptr
; SetXStateFeaturesMask varptr(Context), FeatureMask   ; 戻り値は stat
; Context : CONTEXT* in/out -> "sptr"
; FeatureMask : ULONGLONG -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global SetXStateFeaturesMask "SetXStateFeaturesMask" var, int64
; res = SetXStateFeaturesMask(Context, FeatureMask)
; Context : CONTEXT* in/out -> "var"
; FeatureMask : ULONGLONG -> "int64"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; BOOL SetXStateFeaturesMask(CONTEXT* Context, ULONGLONG FeatureMask)
#uselib "KERNEL32.dll"
#cfunc global SetXStateFeaturesMask "SetXStateFeaturesMask" var, int64
; res = SetXStateFeaturesMask(Context, FeatureMask)
; Context : CONTEXT* in/out -> "var"
; FeatureMask : ULONGLONG -> "int64"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetXStateFeaturesMask = kernel32.NewProc("SetXStateFeaturesMask")
)

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

extern "kernel32" fn SetXStateFeaturesMask(
    Context: [*c]CONTEXT, // CONTEXT* in/out
    FeatureMask: u64 // ULONGLONG
) callconv(std.os.windows.WINAPI) i32;
proc SetXStateFeaturesMask(
    Context: ptr CONTEXT,  # CONTEXT* in/out
    FeatureMask: uint64  # ULONGLONG
): int32 {.importc: "SetXStateFeaturesMask", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetXStateFeaturesMask(
    CONTEXT* Context,   // CONTEXT* in/out
    ulong FeatureMask   // ULONGLONG
);
ccall((:SetXStateFeaturesMask, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{CONTEXT}, UInt64),
      Context, FeatureMask)
# Context : CONTEXT* in/out -> Ptr{CONTEXT}
# FeatureMask : ULONGLONG -> UInt64
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetXStateFeaturesMask(
    void* Context,
    uint64_t FeatureMask);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetXStateFeaturesMask(Context, FeatureMask)
-- Context : CONTEXT* in/out
-- FeatureMask : ULONGLONG
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetXStateFeaturesMask = lib.func('__stdcall', 'SetXStateFeaturesMask', 'int32_t', ['void *', 'uint64_t']);
// SetXStateFeaturesMask(Context, FeatureMask)
// Context : CONTEXT* in/out -> 'void *'
// FeatureMask : ULONGLONG -> 'uint64_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetXStateFeaturesMask: { parameters: ["pointer", "u64"], result: "i32" },
});
// lib.symbols.SetXStateFeaturesMask(Context, FeatureMask)
// Context : CONTEXT* in/out -> "pointer"
// FeatureMask : ULONGLONG -> "u64"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetXStateFeaturesMask(
    void* Context,
    uint64_t FeatureMask);
C, "KERNEL32.dll");
// $ffi->SetXStateFeaturesMask(Context, FeatureMask);
// Context : CONTEXT* in/out
// FeatureMask : ULONGLONG
// 構造体/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);
    boolean SetXStateFeaturesMask(
        Pointer Context,   // CONTEXT* in/out
        long FeatureMask   // ULONGLONG
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetXStateFeaturesMask = SetXStateFeaturesMask(
    Context : CONTEXT*,   # CONTEXT* in/out
    FeatureMask : UInt64   # ULONGLONG
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetXStateFeaturesMaskNative = Int32 Function(Pointer<Void>, Uint64);
typedef SetXStateFeaturesMaskDart = int Function(Pointer<Void>, int);
final SetXStateFeaturesMask = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetXStateFeaturesMaskNative, SetXStateFeaturesMaskDart>('SetXStateFeaturesMask');
// Context : CONTEXT* in/out -> Pointer<Void>
// FeatureMask : ULONGLONG -> Uint64
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetXStateFeaturesMask(
  Context: Pointer;   // CONTEXT* in/out
  FeatureMask: UInt64   // ULONGLONG
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetXStateFeaturesMask';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetXStateFeaturesMask"
  c_SetXStateFeaturesMask :: Ptr () -> Word64 -> IO CInt
-- Context : CONTEXT* in/out -> Ptr ()
-- FeatureMask : ULONGLONG -> Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setxstatefeaturesmask =
  foreign "SetXStateFeaturesMask"
    ((ptr void) @-> uint64_t @-> returning int32_t)
(* Context : CONTEXT* in/out -> (ptr void) *)
(* FeatureMask : ULONGLONG -> uint64_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetXStateFeaturesMask" set-xstate-features-mask :convention :stdcall) :int32
  (context :pointer)   ; CONTEXT* in/out
  (feature-mask :uint64))   ; ULONGLONG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetXStateFeaturesMask = Win32::API::More->new('KERNEL32',
    'BOOL SetXStateFeaturesMask(LPVOID Context, UINT64 FeatureMask)');
# my $ret = $SetXStateFeaturesMask->Call($Context, $FeatureMask);
# Context : CONTEXT* in/out -> LPVOID
# FeatureMask : ULONGLONG -> UINT64
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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