SetThreadPriority
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL SetThreadPriority(
HANDLE hThread,
THREAD_PRIORITY nPriority
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hThread | HANDLE | in | 優先度値を設定する対象スレッドへのハンドル。 このハンドルには THREAD_SET_INFORMATION または THREAD_SET_LIMITED_INFORMATION アクセス権が必要です。詳細については、 Thread Security and Access Rights を参照してください。Windows Server 2003: このハンドルには THREAD_SET_INFORMATION アクセス権が必要です。 | ||||||||||||||||||||
| nPriority | THREAD_PRIORITY | in | スレッドの優先度値。このパラメーターには、次のいずれかの値を指定できます。
スレッドが REALTIME_PRIORITY_CLASS ベースクラスを持つ場合、このパラメーターには -7、-6、-5、-4、-3、3、4、5、6 も指定できます。詳細については、 Scheduling Priorities を参照してください。 |
戻り値の型: BOOL
公式ドキュメント
指定したスレッドの優先度値を設定します。この値は、スレッドが属するプロセスの優先度クラスと組み合わさって、スレッドのベース優先度レベルを決定します。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。
Windows Phone 8.1: Windows Phone ストアアプリはこの関数を呼び出せますが、効果はありません。関数は成功を示す 0 以外の値を返します。
解説(Remarks)
すべてのスレッドは、スレッドの優先度値とプロセスの優先度クラスによって決まるベース優先度レベルを持ちます。システムは、実行可能なすべてのスレッドのベース優先度レベルを使用して、次に CPU 時間を割り当てるスレッドを決定します。スレッドは各優先度レベルでラウンドロビン方式によりスケジュールされ、より高いレベルに実行可能なスレッドが存在しない場合にのみ、より低いレベルのスレッドがスケジュールされます。
SetThreadPriority 関数を使用すると、スレッドのベース優先度レベルをプロセスの優先度クラスを基準として設定できます。たとえば、IDLE_PRIORITY_CLASS プロセスのスレッドに対する SetThreadPriority の呼び出しで THREAD_PRIORITY_HIGHEST を指定すると、そのスレッドのベース優先度レベルは 6 に設定されます。優先度クラスとスレッド優先度値の各組み合わせに対するベース優先度レベルを示す表については、 Scheduling Priorities を参照してください。
IDLE_PRIORITY_CLASS、BELOW_NORMAL_PRIORITY_CLASS、NORMAL_PRIORITY_CLASS、ABOVE_NORMAL_PRIORITY_CLASS、および HIGH_PRIORITY_CLASS プロセスでは、スレッドにとって重要なイベントが発生したときに、システムはスレッドのベース優先度レベルを動的に引き上げます。REALTIME_PRIORITY_CLASS プロセスは動的な引き上げを受けません。
すべてのスレッドは最初 THREAD_PRIORITY_NORMAL で開始します。プロセスの優先度クラスを取得および設定するには、 GetPriorityClass 関数および SetPriorityClass 関数を使用します。スレッドの優先度値を取得するには、 GetThreadPriority 関数を使用します。
プロセスの優先度クラスは、タイムクリティカルなアプリケーションと、通常または通常以下のスケジューリング要件を持つアプリケーションを区別するために使用します。スレッド優先度値は、プロセス内のタスク間の相対的な優先度を区別するために使用します。たとえば、ウィンドウの入力を処理するスレッドは、CPU を集中的に使用する計算を実行するスレッドより高い優先度レベルを持つことができます。
優先度を操作する際は、高優先度のスレッドが利用可能な CPU 時間をすべて消費しないよう十分に注意してください。ベース優先度レベルが 11 を超えるスレッドは、オペレーティングシステムの通常の動作を妨げます。REALTIME_PRIORITY_CLASS を使用すると、ディスクキャッシュがフラッシュされなくなったり、マウスが応答しなくなったりするなどの問題が発生する可能性があります。
THREAD_PRIORITY_* の値はスレッドの CPU スケジューリング優先度に影響します。ファイル I/O、ネットワーク I/O、データ処理などのバックグラウンド作業を実行するスレッドの場合、CPU スケジューリング優先度を調整するだけでは不十分です。アイドル CPU 優先度のスレッドでも、ディスクやメモリを使用するとシステムの応答性を容易に妨げる可能性があります。バックグラウンド作業を実行するスレッドは、THREAD_MODE_BACKGROUND_BEGIN および THREAD_MODE_BACKGROUND_END の値を使用してリソーススケジューリング優先度を調整する必要があります。ユーザーと対話するスレッドは THREAD_MODE_BACKGROUND_BEGIN を使用すべきではありません。
スレッドがバックグラウンド処理モードにあるときは、クリティカルセクション、ヒープ、ハンドルなどのリソースをプロセス内の他のスレッドと共有することを最小限に抑える必要があります。そうしないと優先度の逆転が発生する可能性があります。高優先度で実行されているスレッドがある場合、バックグラウンド処理モードのスレッドはすぐにはスケジュールされない可能性がありますが、リソースが完全に枯渇することはありません。
Windows Server 2008 および Windows Vista: システムの起動中、SetThreadPriority 関数は成功の戻り値を返しますが、システムのスタートアップフォルダーから起動されたアプリケーション、または HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Run レジストリキーに記載されているアプリケーションについては、スレッド優先度を変更しません。これらのアプリケーションは、起動中のユーザー操作に対するシステムの応答性を高めるため、短時間 (約 60 秒) は低い優先度で実行されます。
Windows 8.1 および Windows Server 2012 R2: この関数は Windows ストアアプリでサポートされます。
Windows Phone 8.1:Windows Phone ストアアプリはこの関数を呼び出せますが、効果はありません。
例
次の例は、スレッドのバックグラウンドモードの使用方法を示しています。
#include <windows.h>
#include <tchar.h>
int main( void )
{
DWORD dwError, dwThreadPri;
if(!SetThreadPriority(GetCurrentThread(), THREAD_MODE_BACKGROUND_BEGIN))
{
dwError = GetLastError();
if( ERROR_THREAD_MODE_ALREADY_BACKGROUND == dwError)
_tprintf(TEXT("Already in background mode\n"));
else _tprintf(TEXT("Failed to enter background mode (%d)\n"), dwError);
goto Cleanup;
}
// Display thread priority
dwThreadPri = GetThreadPriority(GetCurrentThread());
_tprintf(TEXT("Current thread priority is 0x%x\n"), dwThreadPri);
//
// Perform background work
//
;
if(!SetThreadPriority(GetCurrentThread(), THREAD_MODE_BACKGROUND_END))
{
_tprintf(TEXT("Failed to end background mode (%d)\n"), GetLastError());
}
Cleanup:
// Clean up
;
return 0;
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL SetThreadPriority(
HANDLE hThread,
THREAD_PRIORITY nPriority
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetThreadPriority(
IntPtr hThread, // HANDLE
int nPriority // THREAD_PRIORITY
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetThreadPriority(
hThread As IntPtr, ' HANDLE
nPriority As Integer ' THREAD_PRIORITY
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hThread : HANDLE
' nPriority : THREAD_PRIORITY
Declare PtrSafe Function SetThreadPriority Lib "kernel32" ( _
ByVal hThread As LongPtr, _
ByVal nPriority As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetThreadPriority = ctypes.windll.kernel32.SetThreadPriority
SetThreadPriority.restype = wintypes.BOOL
SetThreadPriority.argtypes = [
wintypes.HANDLE, # hThread : HANDLE
ctypes.c_int, # nPriority : THREAD_PRIORITY
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadPriority = Fiddle::Function.new(
lib['SetThreadPriority'],
[
Fiddle::TYPE_VOIDP, # hThread : HANDLE
Fiddle::TYPE_INT, # nPriority : THREAD_PRIORITY
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SetThreadPriority(
hThread: *mut core::ffi::c_void, // HANDLE
nPriority: i32 // THREAD_PRIORITY
) -> 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 SetThreadPriority(IntPtr hThread, int nPriority);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadPriority' -Namespace Win32 -PassThru
# $api::SetThreadPriority(hThread, nPriority)#uselib "KERNEL32.dll"
#func global SetThreadPriority "SetThreadPriority" sptr, sptr
; SetThreadPriority hThread, nPriority ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; nPriority : THREAD_PRIORITY -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SetThreadPriority "SetThreadPriority" sptr, int
; res = SetThreadPriority(hThread, nPriority)
; hThread : HANDLE -> "sptr"
; nPriority : THREAD_PRIORITY -> "int"; BOOL SetThreadPriority(HANDLE hThread, THREAD_PRIORITY nPriority)
#uselib "KERNEL32.dll"
#cfunc global SetThreadPriority "SetThreadPriority" intptr, int
; res = SetThreadPriority(hThread, nPriority)
; hThread : HANDLE -> "intptr"
; nPriority : THREAD_PRIORITY -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetThreadPriority = kernel32.NewProc("SetThreadPriority")
)
// hThread (HANDLE), nPriority (THREAD_PRIORITY)
r1, _, err := procSetThreadPriority.Call(
uintptr(hThread),
uintptr(nPriority),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetThreadPriority(
hThread: THandle; // HANDLE
nPriority: Integer // THREAD_PRIORITY
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetThreadPriority';result := DllCall("KERNEL32\SetThreadPriority"
, "Ptr", hThread ; HANDLE
, "Int", nPriority ; THREAD_PRIORITY
, "Int") ; return: BOOL●SetThreadPriority(hThread, nPriority) = DLL("KERNEL32.dll", "bool SetThreadPriority(void*, int)")
# 呼び出し: SetThreadPriority(hThread, nPriority)
# hThread : HANDLE -> "void*"
# nPriority : THREAD_PRIORITY -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SetThreadPriority(
hThread: ?*anyopaque, // HANDLE
nPriority: i32 // THREAD_PRIORITY
) callconv(std.os.windows.WINAPI) i32;proc SetThreadPriority(
hThread: pointer, # HANDLE
nPriority: int32 # THREAD_PRIORITY
): int32 {.importc: "SetThreadPriority", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int SetThreadPriority(
void* hThread, // HANDLE
int nPriority // THREAD_PRIORITY
);ccall((:SetThreadPriority, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Int32),
hThread, nPriority)
# hThread : HANDLE -> Ptr{Cvoid}
# nPriority : THREAD_PRIORITY -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetThreadPriority(
void* hThread,
int32_t nPriority);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetThreadPriority(hThread, nPriority)
-- hThread : HANDLE
-- nPriority : THREAD_PRIORITY
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetThreadPriority = lib.func('__stdcall', 'SetThreadPriority', 'int32_t', ['void *', 'int32_t']);
// SetThreadPriority(hThread, nPriority)
// hThread : HANDLE -> 'void *'
// nPriority : THREAD_PRIORITY -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetThreadPriority: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.SetThreadPriority(hThread, nPriority)
// hThread : HANDLE -> "pointer"
// nPriority : THREAD_PRIORITY -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetThreadPriority(
void* hThread,
int32_t nPriority);
C, "KERNEL32.dll");
// $ffi->SetThreadPriority(hThread, nPriority);
// hThread : HANDLE
// nPriority : THREAD_PRIORITY
// 構造体/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 SetThreadPriority(
Pointer hThread, // HANDLE
int nPriority // THREAD_PRIORITY
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SetThreadPriority = SetThreadPriority(
hThread : Void*, # HANDLE
nPriority : Int32 # THREAD_PRIORITY
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetThreadPriorityNative = Int32 Function(Pointer<Void>, Int32);
typedef SetThreadPriorityDart = int Function(Pointer<Void>, int);
final SetThreadPriority = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetThreadPriorityNative, SetThreadPriorityDart>('SetThreadPriority');
// hThread : HANDLE -> Pointer<Void>
// nPriority : THREAD_PRIORITY -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetThreadPriority(
hThread: THandle; // HANDLE
nPriority: Integer // THREAD_PRIORITY
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetThreadPriority';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetThreadPriority"
c_SetThreadPriority :: Ptr () -> Int32 -> IO CInt
-- hThread : HANDLE -> Ptr ()
-- nPriority : THREAD_PRIORITY -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setthreadpriority =
foreign "SetThreadPriority"
((ptr void) @-> int32_t @-> returning int32_t)
(* hThread : HANDLE -> (ptr void) *)
(* nPriority : THREAD_PRIORITY -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("SetThreadPriority" set-thread-priority :convention :stdcall) :int32
(h-thread :pointer) ; HANDLE
(n-priority :int32)) ; THREAD_PRIORITY
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetThreadPriority = Win32::API::More->new('KERNEL32',
'BOOL SetThreadPriority(HANDLE hThread, int nPriority)');
# my $ret = $SetThreadPriority->Call($hThread, $nPriority);
# hThread : HANDLE -> HANDLE
# nPriority : THREAD_PRIORITY -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f GetPriorityClass — 指定プロセスの優先度クラスを取得する。
- f GetThreadPriority — スレッドの優先度レベルを取得する。
- f SetPriorityClass — 指定プロセスの優先度クラスを設定する。