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

GetProcessPriorityBoost

関数
プロセスの優先度ブースト無効化状態を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL GetProcessPriorityBoost(
    HANDLE hProcess,
    BOOL* pDisablePriorityBoost
);

パラメーター

名前方向説明
hProcessHANDLEin

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

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

pDisablePriorityBoostBOOL*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)

各言語での呼び出し定義

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

BOOL GetProcessPriorityBoost(
    HANDLE hProcess,
    BOOL* pDisablePriorityBoost
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetProcessPriorityBoost(
    IntPtr hProcess,   // HANDLE
    out bool pDisablePriorityBoost   // BOOL* out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetProcessPriorityBoost(
    hProcess As IntPtr,   ' HANDLE
    <Out> ByRef pDisablePriorityBoost As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' pDisablePriorityBoost : BOOL* out
Declare PtrSafe Function GetProcessPriorityBoost Lib "kernel32" ( _
    ByVal hProcess 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

GetProcessPriorityBoost = ctypes.windll.kernel32.GetProcessPriorityBoost
GetProcessPriorityBoost.restype = wintypes.BOOL
GetProcessPriorityBoost.argtypes = [
    wintypes.HANDLE,  # hProcess : 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')
GetProcessPriorityBoost = Fiddle::Function.new(
  lib['GetProcessPriorityBoost'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # pDisablePriorityBoost : BOOL* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetProcessPriorityBoost(
        hProcess: *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 GetProcessPriorityBoost(IntPtr hProcess, out bool pDisablePriorityBoost);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetProcessPriorityBoost' -Namespace Win32 -PassThru
# $api::GetProcessPriorityBoost(hProcess, pDisablePriorityBoost)
#uselib "KERNEL32.dll"
#func global GetProcessPriorityBoost "GetProcessPriorityBoost" sptr, sptr
; GetProcessPriorityBoost hProcess, varptr(pDisablePriorityBoost)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; pDisablePriorityBoost : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetProcessPriorityBoost "GetProcessPriorityBoost" sptr, var
; res = GetProcessPriorityBoost(hProcess, pDisablePriorityBoost)
; hProcess : HANDLE -> "sptr"
; pDisablePriorityBoost : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetProcessPriorityBoost(HANDLE hProcess, BOOL* pDisablePriorityBoost)
#uselib "KERNEL32.dll"
#cfunc global GetProcessPriorityBoost "GetProcessPriorityBoost" intptr, var
; res = GetProcessPriorityBoost(hProcess, pDisablePriorityBoost)
; hProcess : HANDLE -> "intptr"
; pDisablePriorityBoost : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetProcessPriorityBoost = kernel32.NewProc("GetProcessPriorityBoost")
)

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

extern "kernel32" fn GetProcessPriorityBoost(
    hProcess: ?*anyopaque, // HANDLE
    pDisablePriorityBoost: [*c]i32 // BOOL* out
) callconv(std.os.windows.WINAPI) i32;
proc GetProcessPriorityBoost(
    hProcess: pointer,  # HANDLE
    pDisablePriorityBoost: ptr int32  # BOOL* out
): int32 {.importc: "GetProcessPriorityBoost", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetProcessPriorityBoost(
    void* hProcess,   // HANDLE
    int* pDisablePriorityBoost   // BOOL* out
);
ccall((:GetProcessPriorityBoost, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Int32}),
      hProcess, pDisablePriorityBoost)
# hProcess : HANDLE -> Ptr{Cvoid}
# pDisablePriorityBoost : BOOL* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetProcessPriorityBoost(
    void* hProcess,
    int32_t* pDisablePriorityBoost);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetProcessPriorityBoost(hProcess, pDisablePriorityBoost)
-- hProcess : HANDLE
-- pDisablePriorityBoost : BOOL* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetProcessPriorityBoost = lib.func('__stdcall', 'GetProcessPriorityBoost', 'int32_t', ['void *', 'int32_t *']);
// GetProcessPriorityBoost(hProcess, pDisablePriorityBoost)
// hProcess : HANDLE -> 'void *'
// pDisablePriorityBoost : BOOL* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetProcessPriorityBoost: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetProcessPriorityBoost(hProcess, pDisablePriorityBoost)
// hProcess : HANDLE -> "pointer"
// pDisablePriorityBoost : BOOL* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetProcessPriorityBoost(
    void* hProcess,
    int32_t* pDisablePriorityBoost);
C, "KERNEL32.dll");
// $ffi->GetProcessPriorityBoost(hProcess, pDisablePriorityBoost);
// hProcess : 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 GetProcessPriorityBoost(
        Pointer hProcess,   // HANDLE
        IntByReference pDisablePriorityBoost   // BOOL* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetProcessPriorityBoost = GetProcessPriorityBoost(
    hProcess : 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 GetProcessPriorityBoostNative = Int32 Function(Pointer<Void>, Pointer<Int32>);
typedef GetProcessPriorityBoostDart = int Function(Pointer<Void>, Pointer<Int32>);
final GetProcessPriorityBoost = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetProcessPriorityBoostNative, GetProcessPriorityBoostDart>('GetProcessPriorityBoost');
// hProcess : HANDLE -> Pointer<Void>
// pDisablePriorityBoost : BOOL* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetProcessPriorityBoost(
  hProcess: THandle;   // HANDLE
  pDisablePriorityBoost: Pointer   // BOOL* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetProcessPriorityBoost';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getprocesspriorityboost =
  foreign "GetProcessPriorityBoost"
    ((ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* hProcess : 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 ("GetProcessPriorityBoost" get-process-priority-boost :convention :stdcall) :int32
  (h-process :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 $GetProcessPriorityBoost = Win32::API::More->new('KERNEL32',
    'BOOL GetProcessPriorityBoost(HANDLE hProcess, LPVOID pDisablePriorityBoost)');
# my $ret = $GetProcessPriorityBoost->Call($hProcess, $pDisablePriorityBoost);
# hProcess : HANDLE -> HANDLE
# pDisablePriorityBoost : BOOL* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目