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

GetPriorityClass

関数
指定プロセスの優先度クラスを取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetPriorityClass(
    HANDLE hProcess
);

パラメーター

名前方向説明
hProcessHANDLEin

プロセスへのハンドル。

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

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

戻り値の型: DWORD

公式ドキュメント

指定したプロセスの優先度クラスを取得します。この値は、プロセス内の各スレッドの優先度値と組み合わせて、各スレッドの基本優先度レベルを決定します。

戻り値

関数が成功した場合、戻り値は指定したプロセスの優先度クラスです。

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

プロセスの優先度クラスは、次のいずれかの値です。

戻り値/値 説明
ABOVE_NORMAL_PRIORITY_CLASS
0x00008000
NORMAL_PRIORITY_CLASS より高く、HIGH_PRIORITY_CLASS より低い優先度を持つプロセスです。
BELOW_NORMAL_PRIORITY_CLASS
0x00004000
IDLE_PRIORITY_CLASS より高く、NORMAL_PRIORITY_CLASS より低い優先度を持つプロセスです。
HIGH_PRIORITY_CLASS
0x00000080
正しく動作するために即座に実行する必要がある、時間的制約の厳しいタスクを実行するプロセスです。高優先度クラスのプロセスのスレッドは、通常またはアイドル優先度クラスのプロセスのスレッドをプリエンプトします。例として、オペレーティングシステムの負荷に関係なく、ユーザーから呼び出されたときに迅速に応答する必要があるタスク一覧があります。高優先度クラスの CPU バウンドなアプリケーションは利用可能なほぼすべてのサイクルを使用する可能性があるため、高優先度クラスを使用する際は細心の注意を払ってください。
IDLE_PRIORITY_CLASS
0x00000040
スレッドがシステムのアイドル時にのみ実行され、より高い優先度クラスで実行されているプロセスのスレッドによってプリエンプトされるプロセスです。例としてスクリーンセーバーがあります。アイドル優先度クラスは子プロセスに継承されます。
NORMAL_PRIORITY_CLASS
0x00000020
特別なスケジューリング上の要件を持たないプロセスです。
REALTIME_PRIORITY_CLASS
0x00000100
可能な限り最も高い優先度を持つプロセスです。リアルタイム優先度クラスのプロセスのスレッドは、重要なタスクを実行しているオペレーティングシステムのプロセスを含む、他のすべてのプロセスのスレッドをプリエンプトします。たとえば、ごく短い間隔を超えて実行されるリアルタイムプロセスは、ディスクキャッシュがフラッシュされなくなったり、マウスが応答しなくなったりする原因となることがあります。

解説(Remarks)

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

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

優先度クラスはエグゼクティブによって維持されるため、すべてのプロセスはクエリ可能な優先度クラスを持ちます。

例については、 Taking a Snapshot and Viewing Processes を参照してください。

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetPriorityClass = kernel32.NewProc("GetPriorityClass")
)

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

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

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

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

let getpriorityclass =
  foreign "GetPriorityClass"
    ((ptr void) @-> returning uint32_t)
(* hProcess : 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 ("GetPriorityClass" get-priority-class :convention :stdcall) :uint32
  (h-process :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetPriorityClass = Win32::API::More->new('KERNEL32',
    'DWORD GetPriorityClass(HANDLE hProcess)');
# my $ret = $GetPriorityClass->Call($hProcess);
# hProcess : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目