ホーム › System.Threading › GetThreadPriorityBoost
GetThreadPriorityBoost
関数スレッドの優先度ブーストの有効状態を取得する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL GetThreadPriorityBoost(
HANDLE hThread,
BOOL* pDisablePriorityBoost
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hThread | HANDLE | in | スレッドへのハンドル。このハンドルには THREAD_QUERY_INFORMATION または THREAD_QUERY_LIMITED_INFORMATION アクセス権が必要です。詳細については、 Thread Security and Access Rights を参照してください。 Windows Server 2003 および Windows XP: このハンドルには THREAD_QUERY_INFORMATION アクセス権が必要です。 |
| pDisablePriorityBoost | BOOL* | out | 優先順位ブースト制御の状態を受け取る変数へのポインター。値が TRUE の場合、動的なブーストが無効であることを示します。値が FALSE の場合、通常の動作であることを示します。 |
戻り値の型: BOOL
公式ドキュメント
指定したスレッドの優先順位ブースト制御の状態を取得します。
戻り値
関数が成功した場合、戻り値は 0 以外になります。この場合、pDisablePriorityBoost パラメーターが指す変数が優先順位ブースト制御の状態を受け取ります。
関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL GetThreadPriorityBoost(
HANDLE hThread,
BOOL* pDisablePriorityBoost
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetThreadPriorityBoost(
IntPtr hThread, // HANDLE
out bool pDisablePriorityBoost // BOOL* out
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetThreadPriorityBoost(
hThread As IntPtr, ' HANDLE
<Out> ByRef pDisablePriorityBoost As Boolean ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hThread : HANDLE
' pDisablePriorityBoost : BOOL* out
Declare PtrSafe Function GetThreadPriorityBoost Lib "kernel32" ( _
ByVal hThread As LongPtr, _
ByRef pDisablePriorityBoost As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetThreadPriorityBoost = ctypes.windll.kernel32.GetThreadPriorityBoost
GetThreadPriorityBoost.restype = wintypes.BOOL
GetThreadPriorityBoost.argtypes = [
wintypes.HANDLE, # hThread : HANDLE
ctypes.c_void_p, # pDisablePriorityBoost : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
GetThreadPriorityBoost = Fiddle::Function.new(
lib['GetThreadPriorityBoost'],
[
Fiddle::TYPE_VOIDP, # hThread : HANDLE
Fiddle::TYPE_VOIDP, # pDisablePriorityBoost : BOOL* out
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn GetThreadPriorityBoost(
hThread: *mut core::ffi::c_void, // HANDLE
pDisablePriorityBoost: *mut i32 // BOOL* 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 GetThreadPriorityBoost(IntPtr hThread, out bool pDisablePriorityBoost);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetThreadPriorityBoost' -Namespace Win32 -PassThru
# $api::GetThreadPriorityBoost(hThread, pDisablePriorityBoost)#uselib "KERNEL32.dll"
#func global GetThreadPriorityBoost "GetThreadPriorityBoost" sptr, sptr
; GetThreadPriorityBoost hThread, varptr(pDisablePriorityBoost) ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; pDisablePriorityBoost : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global GetThreadPriorityBoost "GetThreadPriorityBoost" sptr, var ; res = GetThreadPriorityBoost(hThread, pDisablePriorityBoost) ; hThread : HANDLE -> "sptr" ; pDisablePriorityBoost : BOOL* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetThreadPriorityBoost "GetThreadPriorityBoost" sptr, sptr ; res = GetThreadPriorityBoost(hThread, varptr(pDisablePriorityBoost)) ; hThread : HANDLE -> "sptr" ; pDisablePriorityBoost : BOOL* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL GetThreadPriorityBoost(HANDLE hThread, BOOL* pDisablePriorityBoost) #uselib "KERNEL32.dll" #cfunc global GetThreadPriorityBoost "GetThreadPriorityBoost" intptr, var ; res = GetThreadPriorityBoost(hThread, pDisablePriorityBoost) ; hThread : HANDLE -> "intptr" ; pDisablePriorityBoost : BOOL* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetThreadPriorityBoost(HANDLE hThread, BOOL* pDisablePriorityBoost) #uselib "KERNEL32.dll" #cfunc global GetThreadPriorityBoost "GetThreadPriorityBoost" intptr, intptr ; res = GetThreadPriorityBoost(hThread, varptr(pDisablePriorityBoost)) ; hThread : HANDLE -> "intptr" ; pDisablePriorityBoost : BOOL* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procGetThreadPriorityBoost = kernel32.NewProc("GetThreadPriorityBoost")
)
// hThread (HANDLE), pDisablePriorityBoost (BOOL* out)
r1, _, err := procGetThreadPriorityBoost.Call(
uintptr(hThread),
uintptr(pDisablePriorityBoost),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction GetThreadPriorityBoost(
hThread: THandle; // HANDLE
pDisablePriorityBoost: Pointer // BOOL* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'GetThreadPriorityBoost';result := DllCall("KERNEL32\GetThreadPriorityBoost"
, "Ptr", hThread ; HANDLE
, "Ptr", pDisablePriorityBoost ; BOOL* out
, "Int") ; return: BOOL●GetThreadPriorityBoost(hThread, pDisablePriorityBoost) = DLL("KERNEL32.dll", "bool GetThreadPriorityBoost(void*, void*)")
# 呼び出し: GetThreadPriorityBoost(hThread, pDisablePriorityBoost)
# hThread : HANDLE -> "void*"
# pDisablePriorityBoost : BOOL* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn GetThreadPriorityBoost(
hThread: ?*anyopaque, // HANDLE
pDisablePriorityBoost: [*c]i32 // BOOL* out
) callconv(std.os.windows.WINAPI) i32;proc GetThreadPriorityBoost(
hThread: pointer, # HANDLE
pDisablePriorityBoost: ptr int32 # BOOL* out
): int32 {.importc: "GetThreadPriorityBoost", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int GetThreadPriorityBoost(
void* hThread, // HANDLE
int* pDisablePriorityBoost // BOOL* out
);ccall((:GetThreadPriorityBoost, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Int32}),
hThread, pDisablePriorityBoost)
# hThread : HANDLE -> Ptr{Cvoid}
# pDisablePriorityBoost : BOOL* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t GetThreadPriorityBoost(
void* hThread,
int32_t* pDisablePriorityBoost);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetThreadPriorityBoost(hThread, pDisablePriorityBoost)
-- hThread : HANDLE
-- pDisablePriorityBoost : BOOL* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetThreadPriorityBoost = lib.func('__stdcall', 'GetThreadPriorityBoost', 'int32_t', ['void *', 'int32_t *']);
// GetThreadPriorityBoost(hThread, pDisablePriorityBoost)
// hThread : HANDLE -> 'void *'
// pDisablePriorityBoost : BOOL* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetThreadPriorityBoost: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetThreadPriorityBoost(hThread, pDisablePriorityBoost)
// hThread : HANDLE -> "pointer"
// pDisablePriorityBoost : BOOL* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t GetThreadPriorityBoost(
void* hThread,
int32_t* pDisablePriorityBoost);
C, "KERNEL32.dll");
// $ffi->GetThreadPriorityBoost(hThread, pDisablePriorityBoost);
// hThread : HANDLE
// pDisablePriorityBoost : BOOL* 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 GetThreadPriorityBoost(
Pointer hThread, // HANDLE
IntByReference pDisablePriorityBoost // BOOL* out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GetThreadPriorityBoost = GetThreadPriorityBoost(
hThread : Void*, # HANDLE
pDisablePriorityBoost : Int32* # BOOL* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetThreadPriorityBoostNative = Int32 Function(Pointer<Void>, Pointer<Int32>);
typedef GetThreadPriorityBoostDart = int Function(Pointer<Void>, Pointer<Int32>);
final GetThreadPriorityBoost = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetThreadPriorityBoostNative, GetThreadPriorityBoostDart>('GetThreadPriorityBoost');
// hThread : HANDLE -> Pointer<Void>
// pDisablePriorityBoost : BOOL* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetThreadPriorityBoost(
hThread: THandle; // HANDLE
pDisablePriorityBoost: Pointer // BOOL* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'GetThreadPriorityBoost';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetThreadPriorityBoost"
c_GetThreadPriorityBoost :: Ptr () -> Ptr CInt -> IO CInt
-- hThread : HANDLE -> Ptr ()
-- pDisablePriorityBoost : BOOL* out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getthreadpriorityboost =
foreign "GetThreadPriorityBoost"
((ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* hThread : HANDLE -> (ptr void) *)
(* pDisablePriorityBoost : BOOL* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("GetThreadPriorityBoost" get-thread-priority-boost :convention :stdcall) :int32
(h-thread :pointer) ; HANDLE
(p-disable-priority-boost :pointer)) ; BOOL* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetThreadPriorityBoost = Win32::API::More->new('KERNEL32',
'BOOL GetThreadPriorityBoost(HANDLE hThread, LPVOID pDisablePriorityBoost)');
# my $ret = $GetThreadPriorityBoost->Call($hThread, $pDisablePriorityBoost);
# hThread : HANDLE -> HANDLE
# pDisablePriorityBoost : BOOL* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f OpenThread — 指定した識別子の既存スレッドを開く。
- f SetThreadPriorityBoost — スレッドの動的な優先度ブーストを有効または無効にする。