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

SetPriorityClass

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

シグネチャ

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

BOOL SetPriorityClass(
    HANDLE hProcess,
    PROCESS_CREATION_FLAGS dwPriorityClass
);

パラメーター

名前方向説明
hProcessHANDLEin

プロセスのハンドル。

このハンドルは PROCESS_SET_INFORMATION アクセス権を持っている必要があります。詳細については、 Process Security and Access Rights を参照してください。

dwPriorityClassPROCESS_CREATION_FLAGSin

プロセスの優先度クラス。このパラメーターには次のいずれかの値を指定できます。

優先度 意味
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
特別なスケジューリングの必要がないプロセスです。
PROCESS_MODE_BACKGROUND_BEGIN
0x00100000
バックグラウンド処理モードを開始します。システムはプロセス(およびそのスレッド)のリソーススケジューリング優先度を下げ、フォアグラウンドの動作に大きな影響を与えずにバックグラウンド作業を実行できるようにします。

この値は、hProcess が現在のプロセスのハンドルである場合にのみ指定できます。プロセスが既にバックグラウンド処理モードにある場合、この関数は失敗します。

Windows Server 2003 および Windows XP: この値はサポートされていません。

PROCESS_MODE_BACKGROUND_END
0x00200000
バックグラウンド処理モードを終了します。システムは、プロセスがバックグラウンド処理モードに入る前の状態にプロセス(およびそのスレッド)のリソーススケジューリング優先度を復元します。

この値は、hProcess が現在のプロセスのハンドルである場合にのみ指定できます。プロセスがバックグラウンド処理モードにない場合、この関数は失敗します。

Windows Server 2003 および Windows XP: この値はサポートされていません。

REALTIME_PRIORITY_CLASS
0x00000100
可能な限り最高の優先度を持つプロセスです。このプロセスのスレッドは、重要なタスクを実行しているオペレーティングシステムプロセスを含む、他のすべてのプロセスのスレッドをプリエンプトします。たとえば、ごく短い間隔を超えて実行されるリアルタイムプロセスは、ディスクキャッシュがフラッシュされなくなったり、マウスが応答しなくなったりする原因となることがあります。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスの優先度クラスを設定します。この値とプロセス内の各スレッドの優先度の値によって、各スレッドの基本優先度レベルが決定されます。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

すべてのスレッドは、スレッドの優先度の値とそのプロセスの優先度クラスによって決定される基本優先度レベルを持ちます。システムは、すべての実行可能なスレッドの基本優先度レベルを使用して、次に CPU 時間のスライスを取得するスレッドを決定します。 SetThreadPriority 関数を使用すると、スレッドの基本優先度レベルをそのプロセスの優先度クラスに対して相対的に設定できます。詳細については、 Scheduling Priorities を参照してください。

*_PRIORITY_CLASS の値は、プロセスの CPU スケジューリング優先度に影響します。ファイル I/O、ネットワーク I/O、データ処理などのバックグラウンド作業を実行するプロセスでは、CPU スケジューリング優先度を調整するだけでは不十分です。CPU 優先度がアイドルのプロセスであっても、ディスクやメモリを使用するとシステムの応答性に容易に干渉する可能性があります。バックグラウンド作業を実行するプロセスは、PROCESS_MODE_BACKGROUND_BEGIN および PROCESS_MODE_BACKGROUND_END の値を使用してリソーススケジューリング優先度を調整する必要があります。ユーザーと対話するプロセスは PROCESS_MODE_BACKGROUND_BEGIN を使用すべきではありません。

プロセスがバックグラウンド処理モードにある場合、そのプロセスが作成する新しいスレッドもバックグラウンド処理モードになります。スレッドがバックグラウンド処理モードにある場合、優先度の逆転が発生する可能性があるため、クリティカルセクション、ヒープ、ハンドルなどのリソースをプロセス内の他のスレッドと共有することを最小限に抑える必要があります。高い優先度で実行されているスレッドがある場合、バックグラウンド処理モードのスレッドは速やかにスケジュールされない可能性がありますが、決して枯渇することはありません。

各スレッドは、SetThreadPriority を使用して個別にバックグラウンド処理モードに入ることができます。プロセス内のスレッドがバックグラウンド処理モードに入るために SetThreadPriority を呼び出した後に、バックグラウンド処理モードに入るために SetPriorityClass を呼び出さないでください。プロセスがバックグラウンド処理モードを終了すると、プロセス内のすべてのスレッドがリセットされます。ただし、プロセスはどのスレッドが既にバックグラウンド処理モードにあったかを知ることはできません。

次の例は、プロセスのバックグラウンドモードの使用方法を示しています。

#include <windows.h>
#include <tchar.h>

int main( void )
{
   DWORD dwError, dwPriClass;

   if(!SetPriorityClass(GetCurrentProcess(), PROCESS_MODE_BACKGROUND_BEGIN))
   {
      dwError = GetLastError();
      if( ERROR_PROCESS_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 priority class

   dwPriClass = GetPriorityClass(GetCurrentProcess());

   _tprintf(TEXT("Current priority class is 0x%x\n"), dwPriClass);

   //
   // Perform background work
   //
   ;

   if(!SetPriorityClass(GetCurrentProcess(), PROCESS_MODE_BACKGROUND_END))
   {
      _tprintf(TEXT("Failed to end background mode (%d)\n"), GetLastError());
   }

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetPriorityClass = kernel32.NewProc("SetPriorityClass")
)

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

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

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

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

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

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

関連項目

公式の関連項目
使用する型