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

SetThreadPriorityBoost

関数
スレッドの動的な優先度ブーストを有効または無効にする。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetThreadPriorityBoost(
    HANDLE hThread,
    BOOL bDisablePriorityBoost
);

パラメーター

名前方向説明
hThreadHANDLEin

優先度を引き上げる対象のスレッドへのハンドル。このハンドルには THREAD_SET_INFORMATION または THREAD_SET_LIMITED_INFORMATION アクセス権が必要です。詳細については、 Thread Security and Access Rights を参照してください。

Windows Server 2003 および Windows XP: このハンドルには THREAD_SET_INFORMATION アクセス権が必要です。

bDisablePriorityBoostBOOLinこのパラメーターが TRUE の場合、動的な優先度の引き上げは無効になります。FALSE の場合、動的な引き上げは有効になります。

戻り値の型: BOOL

公式ドキュメント

スレッドの優先度をシステムが一時的に引き上げる機能を無効化または有効化します。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

スレッドが動的優先度クラスのいずれかで実行されている場合、システムはそのスレッドが待機状態から抜け出すときに優先度を一時的に引き上げます。 SetThreadPriorityBoostDisablePriorityBoost パラメーターに TRUE を指定して呼び出すと、スレッドの優先度は引き上げられません。通常の動作に戻すには、 SetThreadPriorityBoostDisablePriorityBoostFALSE を指定して呼び出してください。

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

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadPriorityBoost = Fiddle::Function.new(
  lib['SetThreadPriorityBoost'],
  [
    Fiddle::TYPE_VOIDP,  # hThread : HANDLE
    Fiddle::TYPE_INT,  # bDisablePriorityBoost : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetThreadPriorityBoost(
        hThread: *mut core::ffi::c_void,  // HANDLE
        bDisablePriorityBoost: i32  // BOOL
    ) -> 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 SetThreadPriorityBoost(IntPtr hThread, bool bDisablePriorityBoost);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadPriorityBoost' -Namespace Win32 -PassThru
# $api::SetThreadPriorityBoost(hThread, bDisablePriorityBoost)
#uselib "KERNEL32.dll"
#func global SetThreadPriorityBoost "SetThreadPriorityBoost" sptr, sptr
; SetThreadPriorityBoost hThread, bDisablePriorityBoost   ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; bDisablePriorityBoost : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetThreadPriorityBoost "SetThreadPriorityBoost" sptr, int
; res = SetThreadPriorityBoost(hThread, bDisablePriorityBoost)
; hThread : HANDLE -> "sptr"
; bDisablePriorityBoost : BOOL -> "int"
; BOOL SetThreadPriorityBoost(HANDLE hThread, BOOL bDisablePriorityBoost)
#uselib "KERNEL32.dll"
#cfunc global SetThreadPriorityBoost "SetThreadPriorityBoost" intptr, int
; res = SetThreadPriorityBoost(hThread, bDisablePriorityBoost)
; hThread : HANDLE -> "intptr"
; bDisablePriorityBoost : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetThreadPriorityBoost = kernel32.NewProc("SetThreadPriorityBoost")
)

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

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

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

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

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

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

関連項目

公式の関連項目