ホーム › System.Threading › SetThreadIdealProcessorEx

SetThreadIdealProcessorEx

関数

スレッドの理想プロセッサを設定する(拡張版)。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL SetThreadIdealProcessorEx(
    HANDLE hThread,
    PROCESSOR_NUMBER* lpIdealProcessor,
    PROCESSOR_NUMBER* lpPreviousIdealProcessor   // optional
);

パラメーター

名前	型	方向	説明
hThread	HANDLE	in	理想プロセッサを設定する対象スレッドのハンドル。このハンドルは THREAD_SET_INFORMATION アクセス権を付与して作成されている必要があります。詳細については、Thread Security and Access Rights を参照してください。
lpIdealProcessor	PROCESSOR_NUMBER*	in	目的とする理想プロセッサのプロセッサ番号を指定する PROCESSOR_NUMBER 構造体へのポインター。
lpPreviousIdealProcessor	PROCESSOR_NUMBER*	outoptional	以前の理想プロセッサを受け取る PROCESSOR_NUMBER 構造体へのポインター。このパラメーターは lpIdealProcessor パラメーターと同じメモリ位置を指していても構いません。以前の理想プロセッサが不要な場合は NULL を指定できます。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドの理想プロセッサを設定し、必要に応じて以前の理想プロセッサを取得します。

戻り値

関数が成功した場合は、0 以外の値を返します。

関数が失敗した場合は、0 を返します。拡張エラー情報を取得するには、GetLastError を使用します。

解説(Remarks)

スレッドの理想プロセッサを指定すると、そのスレッドにとって優先されるプロセッサに関するヒントをスケジューラに与えることができます。スケジューラは、可能な場合にスレッドをその理想プロセッサ上で実行します。

Windows 11 および Windows Server 2022 以降では、64 個を超えるプロセッサを備えたシステムにおいて、プロセスおよびスレッドのアフィニティは既定ですべてのプロセッサグループにまたがり、システム内のすべてのプロセッサに及びます。 SetThreadIdealProcessorEx は、優先プロセッサを設定する際に、スレッドのプライマリグループを優先プロセッサが属するグループにも設定します。

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

Windows Phone 8.1: この関数は、Windows Phone 8.1 以降の Windows Phone ストアアプリでサポートされています。

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>

BOOL SetThreadIdealProcessorEx(
    HANDLE hThread,
    PROCESSOR_NUMBER* lpIdealProcessor,
    PROCESSOR_NUMBER* lpPreviousIdealProcessor   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetThreadIdealProcessorEx(
    IntPtr hThread,   // HANDLE
    IntPtr lpIdealProcessor,   // PROCESSOR_NUMBER*
    IntPtr lpPreviousIdealProcessor   // PROCESSOR_NUMBER* optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetThreadIdealProcessorEx(
    hThread As IntPtr,   ' HANDLE
    lpIdealProcessor As IntPtr,   ' PROCESSOR_NUMBER*
    lpPreviousIdealProcessor As IntPtr   ' PROCESSOR_NUMBER* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hThread : HANDLE
' lpIdealProcessor : PROCESSOR_NUMBER*
' lpPreviousIdealProcessor : PROCESSOR_NUMBER* optional, out
Declare PtrSafe Function SetThreadIdealProcessorEx Lib "kernel32" ( _
    ByVal hThread As LongPtr, _
    ByVal lpIdealProcessor As LongPtr, _
    ByVal lpPreviousIdealProcessor As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetThreadIdealProcessorEx = ctypes.windll.kernel32.SetThreadIdealProcessorEx
SetThreadIdealProcessorEx.restype = wintypes.BOOL
SetThreadIdealProcessorEx.argtypes = [
    wintypes.HANDLE,  # hThread : HANDLE
    ctypes.c_void_p,  # lpIdealProcessor : PROCESSOR_NUMBER*
    ctypes.c_void_p,  # lpPreviousIdealProcessor : PROCESSOR_NUMBER* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadIdealProcessorEx = Fiddle::Function.new(
  lib['SetThreadIdealProcessorEx'],
  [
    Fiddle::TYPE_VOIDP,  # hThread : HANDLE
    Fiddle::TYPE_VOIDP,  # lpIdealProcessor : PROCESSOR_NUMBER*
    Fiddle::TYPE_VOIDP,  # lpPreviousIdealProcessor : PROCESSOR_NUMBER* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetThreadIdealProcessorEx(
        hThread: *mut core::ffi::c_void,  // HANDLE
        lpIdealProcessor: *mut PROCESSOR_NUMBER,  // PROCESSOR_NUMBER*
        lpPreviousIdealProcessor: *mut PROCESSOR_NUMBER  // PROCESSOR_NUMBER* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetThreadIdealProcessorEx(IntPtr hThread, IntPtr lpIdealProcessor, IntPtr lpPreviousIdealProcessor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadIdealProcessorEx' -Namespace Win32 -PassThru
# $api::SetThreadIdealProcessorEx(hThread, lpIdealProcessor, lpPreviousIdealProcessor)

#uselib "KERNEL32.dll"
#func global SetThreadIdealProcessorEx "SetThreadIdealProcessorEx" sptr, sptr, sptr
; SetThreadIdealProcessorEx hThread, varptr(lpIdealProcessor), varptr(lpPreviousIdealProcessor)   ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; lpIdealProcessor : PROCESSOR_NUMBER* -> "sptr"
; lpPreviousIdealProcessor : PROCESSOR_NUMBER* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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