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

LockSetForegroundWindow

関数
前面ウィンドウの設定をロックまたは解除する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL LockSetForegroundWindow(
    FOREGROUND_WINDOW_LOCK_CODE uLockCode
);

パラメーター

名前方向説明
uLockCodeFOREGROUND_WINDOW_LOCK_CODEin

SetForegroundWindow への呼び出しを有効にするか無効にするかを指定します。このパラメーターには、次のいずれかの値を指定できます。

意味
LSFW_LOCK
1
SetForegroundWindow への呼び出しを無効にします。
LSFW_UNLOCK
2
SetForegroundWindow への呼び出しを有効にします。

戻り値の型: BOOL

公式ドキュメント

フォアグラウンドプロセスは、LockSetForegroundWindow 関数を呼び出すことで SetForegroundWindow 関数への呼び出しを無効化できます。

戻り値

型: BOOL

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

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

解説(Remarks)

ユーザーが ALT キーを押した場合、またはシステム自体がフォアグラウンドウィンドウを変更する原因となる操作(たとえば、バックグラウンドウィンドウのクリックなど)を行った場合、システムは自動的に SetForegroundWindow への呼び出しを有効化します。

この関数は、他のアプリケーションがフォアグラウンドを変更してユーザーとのやり取りを中断させることを、アプリケーションが防止できるように提供されています。

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

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('USER32.dll')
LockSetForegroundWindow = Fiddle::Function.new(
  lib['LockSetForegroundWindow'],
  [
    -Fiddle::TYPE_INT,  # uLockCode : FOREGROUND_WINDOW_LOCK_CODE
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn LockSetForegroundWindow(
        uLockCode: u32  // FOREGROUND_WINDOW_LOCK_CODE
    ) -> 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 LockSetForegroundWindow(uint uLockCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LockSetForegroundWindow' -Namespace Win32 -PassThru
# $api::LockSetForegroundWindow(uLockCode)
#uselib "USER32.dll"
#func global LockSetForegroundWindow "LockSetForegroundWindow" sptr
; LockSetForegroundWindow uLockCode   ; 戻り値は stat
; uLockCode : FOREGROUND_WINDOW_LOCK_CODE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global LockSetForegroundWindow "LockSetForegroundWindow" int
; res = LockSetForegroundWindow(uLockCode)
; uLockCode : FOREGROUND_WINDOW_LOCK_CODE -> "int"
; BOOL LockSetForegroundWindow(FOREGROUND_WINDOW_LOCK_CODE uLockCode)
#uselib "USER32.dll"
#cfunc global LockSetForegroundWindow "LockSetForegroundWindow" int
; res = LockSetForegroundWindow(uLockCode)
; uLockCode : FOREGROUND_WINDOW_LOCK_CODE -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLockSetForegroundWindow = user32.NewProc("LockSetForegroundWindow")
)

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

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

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

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

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

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

関連項目

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