ホーム › UI.WindowsAndMessaging › FlashWindow
FlashWindow
関数ウィンドウを一度点滅させ注意を促す。
シグネチャ
// USER32.dll
#include <windows.h>
BOOL FlashWindow(
HWND hWnd,
BOOL bInvert
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hWnd | HWND | in | 点滅させるウィンドウへのハンドル。ウィンドウは開いた状態でも最小化された状態でもかまいません。 |
| bInvert | BOOL | in | このパラメーターが TRUE の場合、ウィンドウは一方の状態から他方の状態へ点滅します。FALSE の場合、ウィンドウは元の状態(アクティブまたは非アクティブ)に戻ります。 アプリケーションが最小化されている状態でこのパラメーターが TRUE の場合、タスクバーのウィンドウボタンがアクティブ/非アクティブで点滅します。FALSE の場合、タスクバーのウィンドウボタンは非アクティブで点滅します。つまり色は変化しません。再描画されるかのように点滅しますが、反転による視覚的な手がかりはユーザーに提供されません。 |
戻り値の型: BOOL
公式ドキュメント
指定したウィンドウを1回点滅させます。ウィンドウのアクティブ状態は変更しません。
戻り値
戻り値は、 FlashWindow 関数を呼び出す前のウィンドウの状態を示します。呼び出し前にウィンドウのキャプションがアクティブとして描画されていた場合、戻り値は 0 以外になります。それ以外の場合、戻り値は 0 になります。
解説(Remarks)
ウィンドウを点滅させるとは、ウィンドウが非アクティブからアクティブの状態へ(またはその逆へ)変化したかのようにキャプションバーの外観を変更することを意味します。(非アクティブなキャプションバーはアクティブなキャプションバーに変化し、アクティブなキャプションバーは非アクティブなキャプションバーに変化します。)
通常、ウィンドウの点滅は、ウィンドウが注意を必要としているものの、現在キーボードフォーカスを持っていないことをユーザーに知らせるために行われます。
FlashWindow 関数はウィンドウを1回だけ点滅させます。繰り返し点滅させるには、アプリケーションでシステムタイマーを作成する必要があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll
#include <windows.h>
BOOL FlashWindow(
HWND hWnd,
BOOL bInvert
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool FlashWindow(
IntPtr hWnd, // HWND
bool bInvert // BOOL
);<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function FlashWindow(
hWnd As IntPtr, ' HWND
bInvert As Boolean ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hWnd : HWND
' bInvert : BOOL
Declare PtrSafe Function FlashWindow Lib "user32" ( _
ByVal hWnd As LongPtr, _
ByVal bInvert As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FlashWindow = ctypes.windll.user32.FlashWindow
FlashWindow.restype = wintypes.BOOL
FlashWindow.argtypes = [
wintypes.HANDLE, # hWnd : HWND
wintypes.BOOL, # bInvert : BOOL
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
FlashWindow = Fiddle::Function.new(
lib['FlashWindow'],
[
Fiddle::TYPE_VOIDP, # hWnd : HWND
Fiddle::TYPE_INT, # bInvert : BOOL
],
Fiddle::TYPE_INT)#[link(name = "user32")]
extern "system" {
fn FlashWindow(
hWnd: *mut core::ffi::c_void, // HWND
bInvert: i32 // BOOL
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll")]
public static extern bool FlashWindow(IntPtr hWnd, bool bInvert);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_FlashWindow' -Namespace Win32 -PassThru
# $api::FlashWindow(hWnd, bInvert)#uselib "USER32.dll"
#func global FlashWindow "FlashWindow" sptr, sptr
; FlashWindow hWnd, bInvert ; 戻り値は stat
; hWnd : HWND -> "sptr"
; bInvert : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global FlashWindow "FlashWindow" sptr, int
; res = FlashWindow(hWnd, bInvert)
; hWnd : HWND -> "sptr"
; bInvert : BOOL -> "int"; BOOL FlashWindow(HWND hWnd, BOOL bInvert)
#uselib "USER32.dll"
#cfunc global FlashWindow "FlashWindow" intptr, int
; res = FlashWindow(hWnd, bInvert)
; hWnd : HWND -> "intptr"
; bInvert : BOOL -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procFlashWindow = user32.NewProc("FlashWindow")
)
// hWnd (HWND), bInvert (BOOL)
r1, _, err := procFlashWindow.Call(
uintptr(hWnd),
uintptr(bInvert),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction FlashWindow(
hWnd: THandle; // HWND
bInvert: BOOL // BOOL
): BOOL; stdcall;
external 'USER32.dll' name 'FlashWindow';result := DllCall("USER32\FlashWindow"
, "Ptr", hWnd ; HWND
, "Int", bInvert ; BOOL
, "Int") ; return: BOOL●FlashWindow(hWnd, bInvert) = DLL("USER32.dll", "bool FlashWindow(void*, bool)")
# 呼び出し: FlashWindow(hWnd, bInvert)
# hWnd : HWND -> "void*"
# bInvert : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn FlashWindow(
hWnd: ?*anyopaque, // HWND
bInvert: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;proc FlashWindow(
hWnd: pointer, # HWND
bInvert: int32 # BOOL
): int32 {.importc: "FlashWindow", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
int FlashWindow(
void* hWnd, // HWND
int bInvert // BOOL
);ccall((:FlashWindow, "USER32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Int32),
hWnd, bInvert)
# hWnd : HWND -> Ptr{Cvoid}
# bInvert : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t FlashWindow(
void* hWnd,
int32_t bInvert);
]]
local user32 = ffi.load("user32")
-- user32.FlashWindow(hWnd, bInvert)
-- hWnd : HWND
-- bInvert : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const FlashWindow = lib.func('__stdcall', 'FlashWindow', 'int32_t', ['void *', 'int32_t']);
// FlashWindow(hWnd, bInvert)
// hWnd : HWND -> 'void *'
// bInvert : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
FlashWindow: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.FlashWindow(hWnd, bInvert)
// hWnd : HWND -> "pointer"
// bInvert : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t FlashWindow(
void* hWnd,
int32_t bInvert);
C, "USER32.dll");
// $ffi->FlashWindow(hWnd, bInvert);
// hWnd : HWND
// bInvert : BOOL
// 構造体/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 FlashWindow(
Pointer hWnd, // HWND
boolean bInvert // BOOL
);
}@[Link("user32")]
lib LibUSER32
fun FlashWindow = FlashWindow(
hWnd : Void*, # HWND
bInvert : Int32 # BOOL
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef FlashWindowNative = Int32 Function(Pointer<Void>, Int32);
typedef FlashWindowDart = int Function(Pointer<Void>, int);
final FlashWindow = DynamicLibrary.open('USER32.dll')
.lookupFunction<FlashWindowNative, FlashWindowDart>('FlashWindow');
// hWnd : HWND -> Pointer<Void>
// bInvert : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FlashWindow(
hWnd: THandle; // HWND
bInvert: BOOL // BOOL
): BOOL; stdcall;
external 'USER32.dll' name 'FlashWindow';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FlashWindow"
c_FlashWindow :: Ptr () -> CInt -> IO CInt
-- hWnd : HWND -> Ptr ()
-- bInvert : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let flashwindow =
foreign "FlashWindow"
((ptr void) @-> int32_t @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* bInvert : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)
(cffi:defcfun ("FlashWindow" flash-window :convention :stdcall) :int32
(h-wnd :pointer) ; HWND
(b-invert :int32)) ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FlashWindow = Win32::API::More->new('USER32',
'BOOL FlashWindow(HANDLE hWnd, BOOL bInvert)');
# my $ret = $FlashWindow->Call($hWnd, $bInvert);
# hWnd : HWND -> HANDLE
# bInvert : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
類似 API
- f FlashWindowEx — ウィンドウやタスクバーを指定方法で点滅させる。