Win32 API 日本語リファレンス
ホームSystem.Threading › GetThreadSelectedCpuSets

GetThreadSelectedCpuSets

関数
スレッドに選択されたCPUセットIDを取得する。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL GetThreadSelectedCpuSets(
    HANDLE Thread,
    DWORD* CpuSetIds,   // optional
    DWORD CpuSetIdCount,
    DWORD* RequiredIdCount
);

パラメーター

名前方向説明
ThreadHANDLEin選択された CPU Set を照会する対象のスレッドを指定します。このハンドルには THREAD_QUERY_LIMITED_INFORMATION アクセス権が必要です。GetCurrentThread が返す値もここに指定できます。
CpuSetIdsDWORD*outoptionalCPU Set 識別子のリストを取得するための省略可能なバッファーを指定します。
CpuSetIdCountDWORDinCpuSetIds で指定したバッファーの容量を指定します。バッファーが NULL の場合は 0 を指定する必要があります。
RequiredIdCountDWORD*outスレッドの選択された CPU Set のリスト全体を保持するために必要なバッファー容量を指定します。正常に返された場合は、バッファーに格納された ID の数を示します。

戻り値の型: BOOL

公式ドキュメント

SetThreadSelectedCpuSets API を使用して割り当てが設定されている場合に、指定したスレッドの明示的な CPU Set 割り当てを返します。

戻り値

この API は成功時に TRUE を返します。バッファーが十分な大きさでない場合、GetLastError の値は ERROR_INSUFFICIENT_BUFFER になります。有効なパラメーターが渡され、戻りバッファーが十分な大きさである場合、この API は失敗しません。

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

各言語での呼び出し定義

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

BOOL GetThreadSelectedCpuSets(
    HANDLE Thread,
    DWORD* CpuSetIds,   // optional
    DWORD CpuSetIdCount,
    DWORD* RequiredIdCount
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool GetThreadSelectedCpuSets(
    IntPtr Thread,   // HANDLE
    IntPtr CpuSetIds,   // DWORD* optional, out
    uint CpuSetIdCount,   // DWORD
    out uint RequiredIdCount   // DWORD* out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetThreadSelectedCpuSets(
    Thread As IntPtr,   ' HANDLE
    CpuSetIds As IntPtr,   ' DWORD* optional, out
    CpuSetIdCount As UInteger,   ' DWORD
    <Out> ByRef RequiredIdCount As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Thread : HANDLE
' CpuSetIds : DWORD* optional, out
' CpuSetIdCount : DWORD
' RequiredIdCount : DWORD* out
Declare PtrSafe Function GetThreadSelectedCpuSets Lib "kernel32" ( _
    ByVal Thread As LongPtr, _
    ByVal CpuSetIds As LongPtr, _
    ByVal CpuSetIdCount As Long, _
    ByRef RequiredIdCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetThreadSelectedCpuSets = ctypes.windll.kernel32.GetThreadSelectedCpuSets
GetThreadSelectedCpuSets.restype = wintypes.BOOL
GetThreadSelectedCpuSets.argtypes = [
    wintypes.HANDLE,  # Thread : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # CpuSetIds : DWORD* optional, out
    wintypes.DWORD,  # CpuSetIdCount : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredIdCount : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetThreadSelectedCpuSets = kernel32.NewProc("GetThreadSelectedCpuSets")
)

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

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

typedef GetThreadSelectedCpuSetsNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Uint32, Pointer<Uint32>);
typedef GetThreadSelectedCpuSetsDart = int Function(Pointer<Void>, Pointer<Uint32>, int, Pointer<Uint32>);
final GetThreadSelectedCpuSets = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetThreadSelectedCpuSetsNative, GetThreadSelectedCpuSetsDart>('GetThreadSelectedCpuSets');
// Thread : HANDLE -> Pointer<Void>
// CpuSetIds : DWORD* optional, out -> Pointer<Uint32>
// CpuSetIdCount : DWORD -> Uint32
// RequiredIdCount : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetThreadSelectedCpuSets(
  Thread: THandle;   // HANDLE
  CpuSetIds: Pointer;   // DWORD* optional, out
  CpuSetIdCount: DWORD;   // DWORD
  RequiredIdCount: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetThreadSelectedCpuSets';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetThreadSelectedCpuSets"
  c_GetThreadSelectedCpuSets :: Ptr () -> Ptr Word32 -> Word32 -> Ptr Word32 -> IO CInt
-- Thread : HANDLE -> Ptr ()
-- CpuSetIds : DWORD* optional, out -> Ptr Word32
-- CpuSetIdCount : DWORD -> Word32
-- RequiredIdCount : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getthreadselectedcpusets =
  foreign "GetThreadSelectedCpuSets"
    ((ptr void) @-> (ptr uint32_t) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* Thread : HANDLE -> (ptr void) *)
(* CpuSetIds : DWORD* optional, out -> (ptr uint32_t) *)
(* CpuSetIdCount : DWORD -> uint32_t *)
(* RequiredIdCount : DWORD* 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 ("GetThreadSelectedCpuSets" get-thread-selected-cpu-sets :convention :stdcall) :int32
  (thread :pointer)   ; HANDLE
  (cpu-set-ids :pointer)   ; DWORD* optional, out
  (cpu-set-id-count :uint32)   ; DWORD
  (required-id-count :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetThreadSelectedCpuSets = Win32::API::More->new('KERNEL32',
    'BOOL GetThreadSelectedCpuSets(HANDLE Thread, LPVOID CpuSetIds, DWORD CpuSetIdCount, LPVOID RequiredIdCount)');
# my $ret = $GetThreadSelectedCpuSets->Call($Thread, $CpuSetIds, $CpuSetIdCount, $RequiredIdCount);
# Thread : HANDLE -> HANDLE
# CpuSetIds : DWORD* optional, out -> LPVOID
# CpuSetIdCount : DWORD -> DWORD
# RequiredIdCount : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。