ホーム › UI.WindowsAndMessaging › SetAdditionalForegroundBoostProcesses

SetAdditionalForegroundBoostProcesses

関数

前景優先度ブーストを追加対象プロセスへ設定する。

DLLUSER32.dll呼出規約winapi

シグネチャ

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

BOOL SetAdditionalForegroundBoostProcesses(
    HWND topLevelWindow,
    DWORD processHandleCount,
    HANDLE* processHandleArray
);

パラメーター

名前	型	方向	説明
topLevelWindow	HWND	in	アプリケーションのトップレベルウィンドウ (HWND) へのハンドル。
processHandleCount	DWORD	in	processHandleArray に含まれるプロセスハンドルの数。この関数は一度に最大 32 個のハンドルを指定して呼び出すことができます。以前のブースト構成をクリアするには、このパラメーターを 0 に設定し、あわせて processHandleArray を NULL に設定します。
processHandleArray	HANDLE*	in	フォアグラウンドブースト、またはディブースト (ブースト解除) の対象となるプロセスハンドルのグループ。以前のブースト構成をクリアするには、このパラメーターを NULL に設定し、あわせて processHandleCount を 0 に設定します。

戻り値の型: BOOL

公式ドキュメント

SetAdditionalForegroundBoostProcesses は、複数のプロセスがデータまたはレンダリングとしてフォアグラウンドエクスペリエンスに寄与するマルチプロセスアプリケーションモデルを採用したアプリケーションを支援する、パフォーマンスアシスト API です。

戻り値

アプリケーションのブーストに成功した場合は TRUE を、それ以外の場合は FALSE を返します。SetAdditionalForegroundBoostProcesses は最後のエラーコードを設定するため、呼び出しが失敗した場合、アプリケーションは GetLastError() を呼び出して拡張情報 (たとえば ERROR_INVALID_PARAMETER、ERROR_NOT_ENOUGH_MEMORY、または ERROR_ACCESS_DENIED) を取得できます。

解説(Remarks)

この関数は、渡されたトップレベル HWND がそれぞれフォアグラウンドまたはバックグラウンドに移動したときに、まとめてフォアグラウンドブーストまたはディブーストされるプロセスハンドルのグループを受け取ります。渡されたトップレベル HWND がフォアグラウンドウィンドウになるたびに、ハンドル配列で渡されたプロセスにもフォアグラウンドブーストが適用されます。トップレベル HWND がバックグラウンドに移動すると、同様のディブーストが発生します。

この関数に渡すトップレベル HWND は、呼び出し元プロセスが所有している必要があります。呼び出し元プロセスは、processHandleArray 内のプロセスハンドルに対して PROCESS_SET_INFORMATION アクセス権を持っている必要があります。言い換えると、自プロセス内のすべてのウィンドウを完全に制御できる必要があります。外部コンポーネントがフォアグラウンドを奪うウィンドウを挿入した場合や、ダイアログボックスが表示された場合は、ブーストを失います。

2 つのトップレベルウィンドウがある場合は、それぞれについてこの関数を呼び出す必要があります。

SetAdditionalForegroundBoostProcesses が呼び出された時点で、渡されたトップレベル HWND が既にフォアグラウンドにある場合、processHandleArray 内のすべてのプロセスは直ちにブーストされます。

processHandleArray にハンドルが含まれるプロセスは、トップレベル HWND がフォアグラウンドウィンドウになったときにのみフォアグラウンドブーストを受けます。

追加のフォアグラウンドブーストは、次の場合にのみ適用されます。

フォアグラウンドウィンドウが変化したとき、または
ウィンドウがフォアグラウンドにある状態でこの関数が呼び出され、新しいリストにそのプロセスハンドルが含まれているとき、あるいは以前は含まれていたプロセスハンドルがリストに含まれていないとき。

トップレベル HWND を所有するプロセスが終了または強制終了されると、追加のブースト関係は解除され、セカンダリプロセスは追加のフォアグラウンドブーストを受けなくなります。

プライマリプロセスのトップレベル HWND は、そのグループ化されたブースト状態をクリアするか、HWND が破棄されるまで、セカンダリプロセスへの参照を保持し続けます。

例

この単純なシナリオでは、アプリケーションはトップレベルウィンドウの作成時にフォアグラウンドプロセスブースト構成をセットアップします。WM_CREATE が処理されるとき、lParam にハンドル、wParam にハンドルの数を指定してこの関数が呼び出されます。これらのプロセスは、m_AppWindow がフォアグラウンドウィンドウになったり外れたりするのに合わせて、フォアグラウンドまたはバックグラウンドの優先度ブーストを受けます。この関数が呼び出された時点で m_AppWindow がフォアグラウンドウィンドウである場合、それらのプロセスは直ちにフォアグラウンド優先度ブーストも受けます。

case WM_CREATE:   

    // 
    // Configure the passed in worker processes (handles) in lParam, to get foreground priority boost when m_AppWindow moves in and 
    // out of the foreground. 
    //  

    HANDLE *pMyHandles = retinterpret_cast<HANDLE*>(lParam); 
    DWORD cHandles = reinterpret_cast<DWORD>(wParam);  

    If (!SetAdditionalForegroundBoostProcesses(m_AppWindow, cHandles, pMyHandles)) 
    { 
        printf(“SetAdditionalForegroundBoostProcesses() setup failed with error code : %d\n”, GetLastError()); 
    } 

    break;

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

各言語での呼び出し定義

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

BOOL SetAdditionalForegroundBoostProcesses(
    HWND topLevelWindow,
    DWORD processHandleCount,
    HANDLE* processHandleArray
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool SetAdditionalForegroundBoostProcesses(
    IntPtr topLevelWindow,   // HWND
    uint processHandleCount,   // DWORD
    IntPtr processHandleArray   // HANDLE*
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function SetAdditionalForegroundBoostProcesses(
    topLevelWindow As IntPtr,   ' HWND
    processHandleCount As UInteger,   ' DWORD
    processHandleArray As IntPtr   ' HANDLE*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' topLevelWindow : HWND
' processHandleCount : DWORD
' processHandleArray : HANDLE*
Declare PtrSafe Function SetAdditionalForegroundBoostProcesses Lib "user32" ( _
    ByVal topLevelWindow As LongPtr, _
    ByVal processHandleCount As Long, _
    ByVal processHandleArray As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetAdditionalForegroundBoostProcesses = ctypes.windll.user32.SetAdditionalForegroundBoostProcesses
SetAdditionalForegroundBoostProcesses.restype = wintypes.BOOL
SetAdditionalForegroundBoostProcesses.argtypes = [
    wintypes.HANDLE,  # topLevelWindow : HWND
    wintypes.DWORD,  # processHandleCount : DWORD
    ctypes.c_void_p,  # processHandleArray : HANDLE*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetAdditionalForegroundBoostProcesses = Fiddle::Function.new(
  lib['SetAdditionalForegroundBoostProcesses'],
  [
    Fiddle::TYPE_VOIDP,  # topLevelWindow : HWND
    -Fiddle::TYPE_INT,  # processHandleCount : DWORD
    Fiddle::TYPE_VOIDP,  # processHandleArray : HANDLE*
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn SetAdditionalForegroundBoostProcesses(
        topLevelWindow: *mut core::ffi::c_void,  // HWND
        processHandleCount: u32,  // DWORD
        processHandleArray: *mut *mut core::ffi::c_void  // HANDLE*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll")]
public static extern bool SetAdditionalForegroundBoostProcesses(IntPtr topLevelWindow, uint processHandleCount, IntPtr processHandleArray);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetAdditionalForegroundBoostProcesses' -Namespace Win32 -PassThru
# $api::SetAdditionalForegroundBoostProcesses(topLevelWindow, processHandleCount, processHandleArray)

#uselib "USER32.dll"
#func global SetAdditionalForegroundBoostProcesses "SetAdditionalForegroundBoostProcesses" sptr, sptr, sptr
; SetAdditionalForegroundBoostProcesses topLevelWindow, processHandleCount, processHandleArray   ; 戻り値は stat
; topLevelWindow : HWND -> "sptr"
; processHandleCount : DWORD -> "sptr"
; processHandleArray : HANDLE* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "USER32.dll"
#cfunc global SetAdditionalForegroundBoostProcesses "SetAdditionalForegroundBoostProcesses" sptr, int, sptr
; res = SetAdditionalForegroundBoostProcesses(topLevelWindow, processHandleCount, processHandleArray)
; topLevelWindow : HWND -> "sptr"
; processHandleCount : DWORD -> "int"
; processHandleArray : HANDLE* -> "sptr"

; BOOL SetAdditionalForegroundBoostProcesses(HWND topLevelWindow, DWORD processHandleCount, HANDLE* processHandleArray)
#uselib "USER32.dll"
#cfunc global SetAdditionalForegroundBoostProcesses "SetAdditionalForegroundBoostProcesses" intptr, int, intptr
; res = SetAdditionalForegroundBoostProcesses(topLevelWindow, processHandleCount, processHandleArray)
; topLevelWindow : HWND -> "intptr"
; processHandleCount : DWORD -> "int"
; processHandleArray : HANDLE* -> "intptr"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetAdditionalForegroundBoostProcesses = user32.NewProc("SetAdditionalForegroundBoostProcesses")
)

// topLevelWindow (HWND), processHandleCount (DWORD), processHandleArray (HANDLE*)
r1, _, err := procSetAdditionalForegroundBoostProcesses.Call(
	uintptr(topLevelWindow),
	uintptr(processHandleCount),
	uintptr(processHandleArray),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function SetAdditionalForegroundBoostProcesses(
  topLevelWindow: THandle;   // HWND
  processHandleCount: DWORD;   // DWORD
  processHandleArray: Pointer   // HANDLE*
): BOOL; stdcall;
  external 'USER32.dll' name 'SetAdditionalForegroundBoostProcesses';

result := DllCall("USER32\SetAdditionalForegroundBoostProcesses"
    , "Ptr", topLevelWindow   ; HWND
    , "UInt", processHandleCount   ; DWORD
    , "Ptr", processHandleArray   ; HANDLE*
    , "Int")   ; return: BOOL

●SetAdditionalForegroundBoostProcesses(topLevelWindow, processHandleCount, processHandleArray) = DLL("USER32.dll", "bool SetAdditionalForegroundBoostProcesses(void*, dword, void*)")
# 呼び出し: SetAdditionalForegroundBoostProcesses(topLevelWindow, processHandleCount, processHandleArray)
# topLevelWindow : HWND -> "void*"
# processHandleCount : DWORD -> "dword"
# processHandleArray : HANDLE* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "user32" fn SetAdditionalForegroundBoostProcesses(
    topLevelWindow: ?*anyopaque, // HWND
    processHandleCount: u32, // DWORD
    processHandleArray: ?*anyopaque // HANDLE*
) callconv(std.os.windows.WINAPI) i32;

proc SetAdditionalForegroundBoostProcesses(
    topLevelWindow: pointer,  # HWND
    processHandleCount: uint32,  # DWORD
    processHandleArray: pointer  # HANDLE*
): int32 {.importc: "SetAdditionalForegroundBoostProcesses", stdcall, dynlib: "USER32.dll".}

pragma(lib, "user32");
extern(Windows)
int SetAdditionalForegroundBoostProcesses(
    void* topLevelWindow,   // HWND
    uint processHandleCount,   // DWORD
    void* processHandleArray   // HANDLE*
);

ccall((:SetAdditionalForegroundBoostProcesses, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
      topLevelWindow, processHandleCount, processHandleArray)
# topLevelWindow : HWND -> Ptr{Cvoid}
# processHandleCount : DWORD -> UInt32
# processHandleArray : HANDLE* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t SetAdditionalForegroundBoostProcesses(
    void* topLevelWindow,
    uint32_t processHandleCount,
    void* processHandleArray);
]]
local user32 = ffi.load("user32")
-- user32.SetAdditionalForegroundBoostProcesses(topLevelWindow, processHandleCount, processHandleArray)
-- topLevelWindow : HWND
-- processHandleCount : DWORD
-- processHandleArray : HANDLE*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetAdditionalForegroundBoostProcesses = lib.func('__stdcall', 'SetAdditionalForegroundBoostProcesses', 'int32_t', ['void *', 'uint32_t', 'void *']);
// SetAdditionalForegroundBoostProcesses(topLevelWindow, processHandleCount, processHandleArray)
// topLevelWindow : HWND -> 'void *'
// processHandleCount : DWORD -> 'uint32_t'
// processHandleArray : HANDLE* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("USER32.dll", {
  SetAdditionalForegroundBoostProcesses: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetAdditionalForegroundBoostProcesses(topLevelWindow, processHandleCount, processHandleArray)
// topLevelWindow : HWND -> "pointer"
// processHandleCount : DWORD -> "u32"
// processHandleArray : HANDLE* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t SetAdditionalForegroundBoostProcesses(
    void* topLevelWindow,
    uint32_t processHandleCount,
    void* processHandleArray);
C, "USER32.dll");
// $ffi->SetAdditionalForegroundBoostProcesses(topLevelWindow, processHandleCount, processHandleArray);
// topLevelWindow : HWND
// processHandleCount : DWORD
// processHandleArray : 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 User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    boolean SetAdditionalForegroundBoostProcesses(
        Pointer topLevelWindow,   // HWND
        int processHandleCount,   // DWORD
        Pointer processHandleArray   // HANDLE*
    );
}

@[Link("user32")]
lib LibUSER32
  fun SetAdditionalForegroundBoostProcesses = SetAdditionalForegroundBoostProcesses(
    topLevelWindow : Void*,   # HWND
    processHandleCount : UInt32,   # DWORD
    processHandleArray : 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 SetAdditionalForegroundBoostProcessesNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef SetAdditionalForegroundBoostProcessesDart = int Function(Pointer<Void>, int, Pointer<Void>);
final SetAdditionalForegroundBoostProcesses = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetAdditionalForegroundBoostProcessesNative, SetAdditionalForegroundBoostProcessesDart>('SetAdditionalForegroundBoostProcesses');
// topLevelWindow : HWND -> Pointer<Void>
// processHandleCount : DWORD -> Uint32
// processHandleArray : HANDLE* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function SetAdditionalForegroundBoostProcesses(
  topLevelWindow: THandle;   // HWND
  processHandleCount: DWORD;   // DWORD
  processHandleArray: Pointer   // HANDLE*
): BOOL; stdcall;
  external 'USER32.dll' name 'SetAdditionalForegroundBoostProcesses';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetAdditionalForegroundBoostProcesses"
  c_SetAdditionalForegroundBoostProcesses :: Ptr () -> Word32 -> Ptr () -> IO CInt
-- topLevelWindow : HWND -> Ptr ()
-- processHandleCount : DWORD -> Word32
-- processHandleArray : HANDLE* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let setadditionalforegroundboostprocesses =
  foreign "SetAdditionalForegroundBoostProcesses"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* topLevelWindow : HWND -> (ptr void) *)
(* processHandleCount : DWORD -> uint32_t *)
(* processHandleArray : HANDLE* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SetAdditionalForegroundBoostProcesses" set-additional-foreground-boost-processes :convention :stdcall) :int32
  (top-level-window :pointer)   ; HWND
  (process-handle-count :uint32)   ; DWORD
  (process-handle-array :pointer))   ; HANDLE*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $SetAdditionalForegroundBoostProcesses = Win32::API::More->new('USER32',
    'BOOL SetAdditionalForegroundBoostProcesses(HANDLE topLevelWindow, DWORD processHandleCount, HANDLE processHandleArray)');
# my $ret = $SetAdditionalForegroundBoostProcesses->Call($topLevelWindow, $processHandleCount, $processHandleArray);
# topLevelWindow : HWND -> HANDLE
# processHandleCount : DWORD -> DWORD
# processHandleArray : HANDLE* -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。