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

SetThreadIdealProcessor

関数
スレッドの理想プロセッサ番号を設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD SetThreadIdealProcessor(
    HANDLE hThread,
    DWORD dwIdealProcessor
);

パラメーター

名前方向説明
hThreadHANDLEin優先プロセッサを設定する対象スレッドのハンドル。このハンドルには THREAD_SET_INFORMATION アクセス権が必要です。詳細については、 Thread Security and Access Rights を参照してください。
dwIdealProcessorDWORDinスレッドの優先プロセッサの番号。この値は 0 から始まります。このパラメーターが MAXIMUM_PROCESSORS の場合、関数は優先プロセッサを変更せずに現在の優先プロセッサを返します。

戻り値の型: DWORD

公式ドキュメント

スレッドに対して優先プロセッサを設定します。システムは可能な限り、各スレッドをその優先プロセッサ上でスケジュールします。

戻り値

関数が成功すると、戻り値は以前の優先プロセッサです。

関数が失敗すると、戻り値は (DWORD) – 1 です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

コンピューター上のプロセッサ数を確認するには、GetSystemInfo 関数を使用できます。また、 GetProcessAffinityMask 関数を使用して、スレッドの実行が許可されているプロセッサを確認することもできます。なお、 GetProcessAffinityMask はビットマスクを返すのに対し、 SetThreadIdealProcessor はプロセッサを表すために整数値を使用する点に注意してください。

Windows 11 および Windows Server 2022 以降では、64 を超えるプロセッサを搭載したシステムにおいて、プロセスおよびスレッドのアフィニティは既定ですべてのプロセッサ グループにわたるシステム内のすべてのプロセッサに及びます。 SetThreadIdealProcessor 関数は、スレッドのプライマリ グループ内の論理プロセッサに優先プロセッサを設定します。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0400 以降として定義してください。詳細については、 Using the Windows Headers を参照してください。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストア アプリでサポートされています。

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

各言語での呼び出し定義

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

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

SetThreadIdealProcessor = ctypes.windll.kernel32.SetThreadIdealProcessor
SetThreadIdealProcessor.restype = wintypes.DWORD
SetThreadIdealProcessor.argtypes = [
    wintypes.HANDLE,  # hThread : HANDLE
    wintypes.DWORD,  # dwIdealProcessor : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadIdealProcessor = Fiddle::Function.new(
  lib['SetThreadIdealProcessor'],
  [
    Fiddle::TYPE_VOIDP,  # hThread : HANDLE
    -Fiddle::TYPE_INT,  # dwIdealProcessor : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetThreadIdealProcessor(
        hThread: *mut core::ffi::c_void,  // HANDLE
        dwIdealProcessor: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern uint SetThreadIdealProcessor(IntPtr hThread, uint dwIdealProcessor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadIdealProcessor' -Namespace Win32 -PassThru
# $api::SetThreadIdealProcessor(hThread, dwIdealProcessor)
#uselib "KERNEL32.dll"
#func global SetThreadIdealProcessor "SetThreadIdealProcessor" sptr, sptr
; SetThreadIdealProcessor hThread, dwIdealProcessor   ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; dwIdealProcessor : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetThreadIdealProcessor "SetThreadIdealProcessor" sptr, int
; res = SetThreadIdealProcessor(hThread, dwIdealProcessor)
; hThread : HANDLE -> "sptr"
; dwIdealProcessor : DWORD -> "int"
; DWORD SetThreadIdealProcessor(HANDLE hThread, DWORD dwIdealProcessor)
#uselib "KERNEL32.dll"
#cfunc global SetThreadIdealProcessor "SetThreadIdealProcessor" intptr, int
; res = SetThreadIdealProcessor(hThread, dwIdealProcessor)
; hThread : HANDLE -> "intptr"
; dwIdealProcessor : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetThreadIdealProcessor = kernel32.NewProc("SetThreadIdealProcessor")
)

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

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

typedef SetThreadIdealProcessorNative = Uint32 Function(Pointer<Void>, Uint32);
typedef SetThreadIdealProcessorDart = int Function(Pointer<Void>, int);
final SetThreadIdealProcessor = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetThreadIdealProcessorNative, SetThreadIdealProcessorDart>('SetThreadIdealProcessor');
// hThread : HANDLE -> Pointer<Void>
// dwIdealProcessor : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetThreadIdealProcessor(
  hThread: THandle;   // HANDLE
  dwIdealProcessor: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'SetThreadIdealProcessor';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetThreadIdealProcessor"
  c_SetThreadIdealProcessor :: Ptr () -> Word32 -> IO Word32
-- hThread : HANDLE -> Ptr ()
-- dwIdealProcessor : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setthreadidealprocessor =
  foreign "SetThreadIdealProcessor"
    ((ptr void) @-> uint32_t @-> returning uint32_t)
(* hThread : HANDLE -> (ptr void) *)
(* dwIdealProcessor : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetThreadIdealProcessor" set-thread-ideal-processor :convention :stdcall) :uint32
  (h-thread :pointer)   ; HANDLE
  (dw-ideal-processor :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetThreadIdealProcessor = Win32::API::More->new('KERNEL32',
    'DWORD SetThreadIdealProcessor(HANDLE hThread, DWORD dwIdealProcessor)');
# my $ret = $SetThreadIdealProcessor->Call($hThread, $dwIdealProcessor);
# hThread : HANDLE -> HANDLE
# dwIdealProcessor : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目