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

GetThreadPriority

関数
スレッドの優先度レベルを取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

INT GetThreadPriority(
    HANDLE hThread
);

パラメーター

名前方向説明
hThreadHANDLEin

スレッドへのハンドル。

このハンドルには THREAD_QUERY_INFORMATION または THREAD_QUERY_LIMITED_INFORMATION アクセス権が必要です。詳細については、 Thread Security and Access Rights を参照してください。

Windows Server 2003: このハンドルには THREAD_QUERY_INFORMATION アクセス権が必要です。

戻り値の型: INT

公式ドキュメント

指定したスレッドの優先度値を取得します。この値は、スレッドが属するプロセスの優先度クラスと組み合わさって、スレッドのベース優先度レベルを決定します。

戻り値

関数が成功した場合、戻り値はスレッドの優先度レベルです。

関数が失敗した場合、戻り値は THREAD_PRIORITY_ERROR_RETURN です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

Windows Phone 8.1: この関数は常に THREAD_PRIORITY_NORMAL を返します。

スレッドの優先度レベルは、次のいずれかの値です。

戻り値/値 説明
THREAD_PRIORITY_ABOVE_NORMAL
1
優先度クラスより 1 ポイント高い優先度です。
THREAD_PRIORITY_BELOW_NORMAL
-1
優先度クラスより 1 ポイント低い優先度です。
THREAD_PRIORITY_HIGHEST
2
優先度クラスより 2 ポイント高い優先度です。
THREAD_PRIORITY_IDLE
-15
IDLE_PRIORITY_CLASSBELOW_NORMAL_PRIORITY_CLASSNORMAL_PRIORITY_CLASSABOVE_NORMAL_PRIORITY_CLASS、または HIGH_PRIORITY_CLASS のプロセスではベース優先度 1、REALTIME_PRIORITY_CLASS のプロセスではベース優先度 16 となります。
THREAD_PRIORITY_LOWEST
-2
優先度クラスより 2 ポイント低い優先度です。
THREAD_PRIORITY_NORMAL
0
優先度クラスの通常優先度です。
THREAD_PRIORITY_TIME_CRITICAL
15
IDLE_PRIORITY_CLASSBELOW_NORMAL_PRIORITY_CLASSNORMAL_PRIORITY_CLASSABOVE_NORMAL_PRIORITY_CLASS、または HIGH_PRIORITY_CLASS のプロセスではベース優先度レベル 15、REALTIME_PRIORITY_CLASS のプロセスではベース優先度レベル 31 となります。

スレッドが REALTIME_PRIORITY_CLASS のベースクラスを持つ場合、この関数は次のいずれかの値を返すこともあります: -7、-6、-5、-4、-3、3、4、5、または 6。詳細については、 Scheduling Priorities を参照してください。

解説(Remarks)

すべてのスレッドは、スレッドの優先度値とそのプロセスの優先度クラスによって決まるベース優先度レベルを持ちます。オペレーティング システムは、実行可能なすべてのスレッドのベース優先度レベルを使用して、次に CPU 時間を割り当てるスレッドを決定します。スレッドは各優先度レベルでラウンドロビン方式でスケジュールされ、より高いレベルに実行可能なスレッドが存在しない場合にのみ、より低いレベルのスレッドのスケジュールが行われます。

優先度クラスとスレッド優先度値の各組み合わせに対するベース優先度レベルを示す表については、 SetPriorityClass 関数を参照してください。

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

Windows Phone 8.1:Windows Phone ストア アプリはこの関数を呼び出すことができますが、効果はありません。

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetThreadPriority = kernel32.NewProc("GetThreadPriority")
)

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

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

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

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

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

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

関連項目

公式の関連項目