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

EnumPropsExW

関数
ウィンドウのプロパティを拡張コールバックで列挙する(Unicode版)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT EnumPropsExW(
    HWND hWnd,
    PROPENUMPROCEXW lpEnumFunc,
    LPARAM lParam
);

パラメーター

名前方向説明
hWndHWNDinプロパティリストを列挙する対象ウィンドウへのハンドルです。
lpEnumFuncPROPENUMPROCEXWinコールバック関数へのポインターです。コールバック関数の詳細については、PropEnumProcEx 関数を参照してください。
lParamLPARAMinコールバック関数に渡される、アプリケーション定義のデータです。

戻り値の型: INT

公式ドキュメント

ウィンドウのプロパティリストにあるすべてのエントリを、指定されたコールバック関数に1つずつ渡して列挙します。EnumPropsEx は、最後のエントリが列挙されるか、コールバック関数が FALSE を返すまで処理を続けます。(Unicode)

戻り値

型: int

戻り値は、コールバック関数が最後に返した値を表します。列挙対象のプロパティが見つからなかった場合は -1 になります。

解説(Remarks)

アプリケーションは、自身が追加したプロパティのみを削除できます。他のアプリケーションやシステム自体が追加したプロパティを削除してはなりません。

例については、指定されたウィンドウのウィンドウプロパティを列挙するを参照してください。

メモ

winuser.h ヘッダーは EnumPropsEx を、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディングに依存しないエイリアスの使用と、エンコーディングに依存しないわけではないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT EnumPropsExW(
    HWND hWnd,
    PROPENUMPROCEXW lpEnumFunc,
    LPARAM lParam
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int EnumPropsExW(
    IntPtr hWnd,   // HWND
    IntPtr lpEnumFunc,   // PROPENUMPROCEXW
    IntPtr lParam   // LPARAM
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function EnumPropsExW(
    hWnd As IntPtr,   ' HWND
    lpEnumFunc As IntPtr,   ' PROPENUMPROCEXW
    lParam As IntPtr   ' LPARAM
) As Integer
End Function
' hWnd : HWND
' lpEnumFunc : PROPENUMPROCEXW
' lParam : LPARAM
Declare PtrSafe Function EnumPropsExW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpEnumFunc As LongPtr, _
    ByVal lParam As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EnumPropsExW = ctypes.windll.user32.EnumPropsExW
EnumPropsExW.restype = ctypes.c_int
EnumPropsExW.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_void_p,  # lpEnumFunc : PROPENUMPROCEXW
    ctypes.c_ssize_t,  # lParam : LPARAM
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
EnumPropsExW = Fiddle::Function.new(
  lib['EnumPropsExW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpEnumFunc : PROPENUMPROCEXW
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn EnumPropsExW(
        hWnd: *mut core::ffi::c_void,  // HWND
        lpEnumFunc: *const core::ffi::c_void,  // PROPENUMPROCEXW
        lParam: isize  // LPARAM
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode)]
public static extern int EnumPropsExW(IntPtr hWnd, IntPtr lpEnumFunc, IntPtr lParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EnumPropsExW' -Namespace Win32 -PassThru
# $api::EnumPropsExW(hWnd, lpEnumFunc, lParam)
#uselib "USER32.dll"
#func global EnumPropsExW "EnumPropsExW" wptr, wptr, wptr
; EnumPropsExW hWnd, lpEnumFunc, lParam   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; lpEnumFunc : PROPENUMPROCEXW -> "wptr"
; lParam : LPARAM -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global EnumPropsExW "EnumPropsExW" sptr, sptr, sptr
; res = EnumPropsExW(hWnd, lpEnumFunc, lParam)
; hWnd : HWND -> "sptr"
; lpEnumFunc : PROPENUMPROCEXW -> "sptr"
; lParam : LPARAM -> "sptr"
; INT EnumPropsExW(HWND hWnd, PROPENUMPROCEXW lpEnumFunc, LPARAM lParam)
#uselib "USER32.dll"
#cfunc global EnumPropsExW "EnumPropsExW" intptr, intptr, intptr
; res = EnumPropsExW(hWnd, lpEnumFunc, lParam)
; hWnd : HWND -> "intptr"
; lpEnumFunc : PROPENUMPROCEXW -> "intptr"
; lParam : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procEnumPropsExW = user32.NewProc("EnumPropsExW")
)

// hWnd (HWND), lpEnumFunc (PROPENUMPROCEXW), lParam (LPARAM)
r1, _, err := procEnumPropsExW.Call(
	uintptr(hWnd),
	uintptr(lpEnumFunc),
	uintptr(lParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function EnumPropsExW(
  hWnd: THandle;   // HWND
  lpEnumFunc: Pointer;   // PROPENUMPROCEXW
  lParam: NativeInt   // LPARAM
): Integer; stdcall;
  external 'USER32.dll' name 'EnumPropsExW';
result := DllCall("USER32\EnumPropsExW"
    , "Ptr", hWnd   ; HWND
    , "Ptr", lpEnumFunc   ; PROPENUMPROCEXW
    , "Ptr", lParam   ; LPARAM
    , "Int")   ; return: INT
●EnumPropsExW(hWnd, lpEnumFunc, lParam) = DLL("USER32.dll", "int EnumPropsExW(void*, void*, int)")
# 呼び出し: EnumPropsExW(hWnd, lpEnumFunc, lParam)
# hWnd : HWND -> "void*"
# lpEnumFunc : PROPENUMPROCEXW -> "void*"
# lParam : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn EnumPropsExW(
    hWnd: ?*anyopaque, // HWND
    lpEnumFunc: ?*anyopaque, // PROPENUMPROCEXW
    lParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc EnumPropsExW(
    hWnd: pointer,  # HWND
    lpEnumFunc: pointer,  # PROPENUMPROCEXW
    lParam: int  # LPARAM
): int32 {.importc: "EnumPropsExW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int EnumPropsExW(
    void* hWnd,   // HWND
    void* lpEnumFunc,   // PROPENUMPROCEXW
    ptrdiff_t lParam   // LPARAM
);
ccall((:EnumPropsExW, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Int),
      hWnd, lpEnumFunc, lParam)
# hWnd : HWND -> Ptr{Cvoid}
# lpEnumFunc : PROPENUMPROCEXW -> Ptr{Cvoid}
# lParam : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t EnumPropsExW(
    void* hWnd,
    void* lpEnumFunc,
    intptr_t lParam);
]]
local user32 = ffi.load("user32")
-- user32.EnumPropsExW(hWnd, lpEnumFunc, lParam)
-- hWnd : HWND
-- lpEnumFunc : PROPENUMPROCEXW
-- lParam : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const EnumPropsExW = lib.func('__stdcall', 'EnumPropsExW', 'int32_t', ['void *', 'void *', 'intptr_t']);
// EnumPropsExW(hWnd, lpEnumFunc, lParam)
// hWnd : HWND -> 'void *'
// lpEnumFunc : PROPENUMPROCEXW -> 'void *'
// lParam : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("USER32.dll", {
  EnumPropsExW: { parameters: ["pointer", "pointer", "isize"], result: "i32" },
});
// lib.symbols.EnumPropsExW(hWnd, lpEnumFunc, lParam)
// hWnd : HWND -> "pointer"
// lpEnumFunc : PROPENUMPROCEXW -> "pointer"
// lParam : LPARAM -> "isize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EnumPropsExW(
    void* hWnd,
    void* lpEnumFunc,
    intptr_t lParam);
C, "USER32.dll");
// $ffi->EnumPropsExW(hWnd, lpEnumFunc, lParam);
// hWnd : HWND
// lpEnumFunc : PROPENUMPROCEXW
// 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, W32APIOptions.UNICODE_OPTIONS);
    int EnumPropsExW(
        Pointer hWnd,   // HWND
        Callback lpEnumFunc,   // PROPENUMPROCEXW
        long lParam   // LPARAM
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun EnumPropsExW = EnumPropsExW(
    hWnd : Void*,   # HWND
    lpEnumFunc : Void*,   # PROPENUMPROCEXW
    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 EnumPropsExWNative = Int32 Function(Pointer<Void>, Pointer<Void>, IntPtr);
typedef EnumPropsExWDart = int Function(Pointer<Void>, Pointer<Void>, int);
final EnumPropsExW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<EnumPropsExWNative, EnumPropsExWDart>('EnumPropsExW');
// hWnd : HWND -> Pointer<Void>
// lpEnumFunc : PROPENUMPROCEXW -> Pointer<Void>
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumPropsExW(
  hWnd: THandle;   // HWND
  lpEnumFunc: Pointer;   // PROPENUMPROCEXW
  lParam: NativeInt   // LPARAM
): Integer; stdcall;
  external 'USER32.dll' name 'EnumPropsExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let enumpropsexw =
  foreign "EnumPropsExW"
    ((ptr void) @-> (ptr void) @-> intptr_t @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* lpEnumFunc : PROPENUMPROCEXW -> (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 ("EnumPropsExW" enum-props-ex-w :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (lp-enum-func :pointer)   ; PROPENUMPROCEXW
  (l-param :int64))   ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumPropsExW = Win32::API::More->new('USER32',
    'int EnumPropsExW(HANDLE hWnd, LPVOID lpEnumFunc, LPARAM lParam)');
# my $ret = $EnumPropsExW->Call($hWnd, $lpEnumFunc, $lParam);
# hWnd : HWND -> HANDLE
# lpEnumFunc : PROPENUMPROCEXW -> LPVOID
# lParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
使用する型