Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › AllowSetForegroundWindow

AllowSetForegroundWindow

関数
指定プロセスに前面化を許可する権限を与える。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL AllowSetForegroundWindow(
    DWORD dwProcessId
);

パラメーター

名前方向説明
dwProcessIdDWORDinフォアグラウンドウィンドウを設定できるようにするプロセスの識別子です。このパラメーターが ASFW_ANY の場合、すべてのプロセスがフォアグラウンドウィンドウを設定できるようになります。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスが SetForegroundWindow 関数を使用してフォアグラウンドウィンドウを設定できるようにします。呼び出し元のプロセスは、あらかじめフォアグラウンドウィンドウを設定できる状態になっている必要があります。詳細については、本トピックの後半の「解説」を参照してください。

戻り値

型: BOOL

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

関数が失敗した場合、戻り値は 0 になります。呼び出し元のプロセスがフォアグラウンドウィンドウを設定できない場合、この関数は失敗します。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

システムは、どのプロセスがフォアグラウンドウィンドウを設定できるかを制限します。通常、プロセスが SetForegroundWindow 関数を呼び出してフォアグラウンドウィンドウを設定できるのは、次の場合のみです。

フォアグラウンドウィンドウを設定できるプロセスは、AllowSetForegroundWindow を呼び出すことで、別のプロセスがフォアグラウンドウィンドウを設定できるようにできます。dwProcessId パラメーターで指定されたプロセスは、ユーザーが次に入力を生成したとき(ただし、その入力がそのプロセスに向けられている場合を除く)、または次にいずれかのプロセスが AllowSetForegroundWindow を呼び出したとき(ただし、前回の AllowSetForegroundWindow の呼び出しと同じプロセスが指定されている場合を除く)に、フォアグラウンドウィンドウを設定する権限を失います。

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

各言語での呼び出し定義

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

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

AllowSetForegroundWindow = ctypes.windll.user32.AllowSetForegroundWindow
AllowSetForegroundWindow.restype = wintypes.BOOL
AllowSetForegroundWindow.argtypes = [
    wintypes.DWORD,  # dwProcessId : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
AllowSetForegroundWindow = Fiddle::Function.new(
  lib['AllowSetForegroundWindow'],
  [
    -Fiddle::TYPE_INT,  # dwProcessId : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn AllowSetForegroundWindow(
        dwProcessId: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool AllowSetForegroundWindow(uint dwProcessId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_AllowSetForegroundWindow' -Namespace Win32 -PassThru
# $api::AllowSetForegroundWindow(dwProcessId)
#uselib "USER32.dll"
#func global AllowSetForegroundWindow "AllowSetForegroundWindow" sptr
; AllowSetForegroundWindow dwProcessId   ; 戻り値は stat
; dwProcessId : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global AllowSetForegroundWindow "AllowSetForegroundWindow" int
; res = AllowSetForegroundWindow(dwProcessId)
; dwProcessId : DWORD -> "int"
; BOOL AllowSetForegroundWindow(DWORD dwProcessId)
#uselib "USER32.dll"
#cfunc global AllowSetForegroundWindow "AllowSetForegroundWindow" int
; res = AllowSetForegroundWindow(dwProcessId)
; dwProcessId : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procAllowSetForegroundWindow = user32.NewProc("AllowSetForegroundWindow")
)

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

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

typedef AllowSetForegroundWindowNative = Int32 Function(Uint32);
typedef AllowSetForegroundWindowDart = int Function(int);
final AllowSetForegroundWindow = DynamicLibrary.open('USER32.dll')
    .lookupFunction<AllowSetForegroundWindowNative, AllowSetForegroundWindowDart>('AllowSetForegroundWindow');
// dwProcessId : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AllowSetForegroundWindow(
  dwProcessId: DWORD   // DWORD
): BOOL; stdcall;
  external 'USER32.dll' name 'AllowSetForegroundWindow';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let allowsetforegroundwindow =
  foreign "AllowSetForegroundWindow"
    (uint32_t @-> returning int32_t)
(* dwProcessId : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("AllowSetForegroundWindow" allow-set-foreground-window :convention :stdcall) :int32
  (dw-process-id :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AllowSetForegroundWindow = Win32::API::More->new('USER32',
    'BOOL AllowSetForegroundWindow(DWORD dwProcessId)');
# my $ret = $AllowSetForegroundWindow->Call($dwProcessId);
# dwProcessId : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。