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

EnumWindows

関数
全トップレベルウィンドウをコールバックで列挙する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL EnumWindows(
    WNDENUMPROC lpEnumFunc,
    LPARAM lParam
);

パラメーター

名前方向説明
lpEnumFuncWNDENUMPROCinアプリケーション定義のコールバック関数へのポインターです。詳細については、EnumWindowsProc を参照してください。
lParamLPARAMinコールバック関数へ渡される、アプリケーション定義の値です。

戻り値の型: BOOL

公式ドキュメント

画面上のすべてのトップレベルウィンドウを列挙し、各ウィンドウのハンドルを順番にアプリケーション定義のコールバック関数へ渡します。EnumWindows は、最後のトップレベルウィンドウが列挙されるか、コールバック関数が FALSE を返すまで処理を続けます。

戻り値

型: BOOL

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

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

EnumWindowsProc が 0 を返した場合も、戻り値は 0 になります。この場合、コールバック関数は SetLastError を呼び出し、EnumWindows の呼び出し元へ返す意味のあるエラーコードを設定する必要があります。

解説(Remarks)

EnumWindows 関数は子ウィンドウを列挙しません。ただし、WS_CHILD スタイルを持つ、システムが所有する一部のトップレベルウィンドウは例外です。

この関数は、GetWindow 関数をループ内で呼び出すよりも信頼性が高い方法です。この処理を行うために GetWindow を呼び出すアプリケーションは、無限ループに陥ったり、既に破棄されたウィンドウのハンドルを参照したりする危険があります。

注意 Windows 8 以降では、EnumWindows はデスクトップアプリのトップレベルウィンドウのみを列挙します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

EnumWindows = ctypes.windll.user32.EnumWindows
EnumWindows.restype = wintypes.BOOL
EnumWindows.argtypes = [
    ctypes.c_void_p,  # lpEnumFunc : WNDENUMPROC
    ctypes.c_ssize_t,  # lParam : LPARAM
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
EnumWindows = Fiddle::Function.new(
  lib['EnumWindows'],
  [
    Fiddle::TYPE_VOIDP,  # lpEnumFunc : WNDENUMPROC
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn EnumWindows(
        lpEnumFunc: *const core::ffi::c_void,  // WNDENUMPROC
        lParam: isize  // LPARAM
    ) -> 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 EnumWindows(IntPtr lpEnumFunc, IntPtr lParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EnumWindows' -Namespace Win32 -PassThru
# $api::EnumWindows(lpEnumFunc, lParam)
#uselib "USER32.dll"
#func global EnumWindows "EnumWindows" sptr, sptr
; EnumWindows lpEnumFunc, lParam   ; 戻り値は stat
; lpEnumFunc : WNDENUMPROC -> "sptr"
; lParam : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global EnumWindows "EnumWindows" sptr, sptr
; res = EnumWindows(lpEnumFunc, lParam)
; lpEnumFunc : WNDENUMPROC -> "sptr"
; lParam : LPARAM -> "sptr"
; BOOL EnumWindows(WNDENUMPROC lpEnumFunc, LPARAM lParam)
#uselib "USER32.dll"
#cfunc global EnumWindows "EnumWindows" intptr, intptr
; res = EnumWindows(lpEnumFunc, lParam)
; lpEnumFunc : WNDENUMPROC -> "intptr"
; lParam : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procEnumWindows = user32.NewProc("EnumWindows")
)

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

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

typedef EnumWindowsNative = Int32 Function(Pointer<Void>, IntPtr);
typedef EnumWindowsDart = int Function(Pointer<Void>, int);
final EnumWindows = DynamicLibrary.open('USER32.dll')
    .lookupFunction<EnumWindowsNative, EnumWindowsDart>('EnumWindows');
// lpEnumFunc : WNDENUMPROC -> Pointer<Void>
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumWindows(
  lpEnumFunc: Pointer;   // WNDENUMPROC
  lParam: NativeInt   // LPARAM
): BOOL; stdcall;
  external 'USER32.dll' name 'EnumWindows';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnumWindows"
  c_EnumWindows :: Ptr () -> CIntPtr -> IO CInt
-- lpEnumFunc : WNDENUMPROC -> Ptr ()
-- lParam : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let enumwindows =
  foreign "EnumWindows"
    ((ptr void) @-> intptr_t @-> returning int32_t)
(* lpEnumFunc : WNDENUMPROC -> (ptr void) *)
(* lParam : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("EnumWindows" enum-windows :convention :stdcall) :int32
  (lp-enum-func :pointer)   ; WNDENUMPROC
  (l-param :int64))   ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumWindows = Win32::API::More->new('USER32',
    'BOOL EnumWindows(LPVOID lpEnumFunc, LPARAM lParam)');
# my $ret = $EnumWindows->Call($lpEnumFunc, $lParam);
# lpEnumFunc : WNDENUMPROC -> LPVOID
# lParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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