ホーム › UI.WindowsAndMessaging › EnumPropsExA
EnumPropsExA
関数ウィンドウのプロパティを拡張コールバックで列挙する(ANSI版)。
シグネチャ
// USER32.dll (ANSI / -A)
#include <windows.h>
INT EnumPropsExA(
HWND hWnd,
PROPENUMPROCEXA lpEnumFunc,
LPARAM lParam
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hWnd | HWND | in | プロパティリストを列挙する対象のウィンドウへのハンドル。 |
| lpEnumFunc | PROPENUMPROCEXA | in | コールバック関数へのポインター。コールバック関数の詳細については、PropEnumProcEx 関数を参照してください。 |
| lParam | LPARAM | in | コールバック関数に渡されるアプリケーション定義のデータ。 |
戻り値の型: INT
公式ドキュメント
ウィンドウのプロパティリスト内のすべてのエントリを、1つずつ指定したコールバック関数に渡して列挙します。EnumPropsEx は、最後のエントリが列挙されるか、コールバック関数が FALSE を返すまで処理を続けます。(ANSI)
戻り値
型: int
戻り値は、コールバック関数が最後に返した値を表します。列挙対象のプロパティが見つからなかった場合は -1 になります。
解説(Remarks)
アプリケーションは、自身が追加したプロパティのみを削除できます。他のアプリケーションやシステム自体が追加したプロパティを削除してはなりません。
例
例については、指定したウィンドウのウィンドウプロパティの一覧表示を参照してください。
メモ
winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして EnumPropsEx を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不整合が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 (ANSI / -A)
#include <windows.h>
INT EnumPropsExA(
HWND hWnd,
PROPENUMPROCEXA lpEnumFunc,
LPARAM lParam
);[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int EnumPropsExA(
IntPtr hWnd, // HWND
IntPtr lpEnumFunc, // PROPENUMPROCEXA
IntPtr lParam // LPARAM
);<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function EnumPropsExA(
hWnd As IntPtr, ' HWND
lpEnumFunc As IntPtr, ' PROPENUMPROCEXA
lParam As IntPtr ' LPARAM
) As Integer
End Function' hWnd : HWND
' lpEnumFunc : PROPENUMPROCEXA
' lParam : LPARAM
Declare PtrSafe Function EnumPropsExA Lib "user32" ( _
ByVal hWnd As LongPtr, _
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
EnumPropsExA = ctypes.windll.user32.EnumPropsExA
EnumPropsExA.restype = ctypes.c_int
EnumPropsExA.argtypes = [
wintypes.HANDLE, # hWnd : HWND
ctypes.c_void_p, # lpEnumFunc : PROPENUMPROCEXA
ctypes.c_ssize_t, # lParam : LPARAM
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
EnumPropsExA = Fiddle::Function.new(
lib['EnumPropsExA'],
[
Fiddle::TYPE_VOIDP, # hWnd : HWND
Fiddle::TYPE_VOIDP, # lpEnumFunc : PROPENUMPROCEXA
Fiddle::TYPE_INTPTR_T, # lParam : LPARAM
],
Fiddle::TYPE_INT)#[link(name = "user32")]
extern "system" {
fn EnumPropsExA(
hWnd: *mut core::ffi::c_void, // HWND
lpEnumFunc: *const core::ffi::c_void, // PROPENUMPROCEXA
lParam: isize // LPARAM
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi)]
public static extern int EnumPropsExA(IntPtr hWnd, IntPtr lpEnumFunc, IntPtr lParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EnumPropsExA' -Namespace Win32 -PassThru
# $api::EnumPropsExA(hWnd, lpEnumFunc, lParam)#uselib "USER32.dll"
#func global EnumPropsExA "EnumPropsExA" sptr, sptr, sptr
; EnumPropsExA hWnd, lpEnumFunc, lParam ; 戻り値は stat
; hWnd : HWND -> "sptr"
; lpEnumFunc : PROPENUMPROCEXA -> "sptr"
; lParam : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global EnumPropsExA "EnumPropsExA" sptr, sptr, sptr
; res = EnumPropsExA(hWnd, lpEnumFunc, lParam)
; hWnd : HWND -> "sptr"
; lpEnumFunc : PROPENUMPROCEXA -> "sptr"
; lParam : LPARAM -> "sptr"; INT EnumPropsExA(HWND hWnd, PROPENUMPROCEXA lpEnumFunc, LPARAM lParam)
#uselib "USER32.dll"
#cfunc global EnumPropsExA "EnumPropsExA" intptr, intptr, intptr
; res = EnumPropsExA(hWnd, lpEnumFunc, lParam)
; hWnd : HWND -> "intptr"
; lpEnumFunc : PROPENUMPROCEXA -> "intptr"
; lParam : LPARAM -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procEnumPropsExA = user32.NewProc("EnumPropsExA")
)
// hWnd (HWND), lpEnumFunc (PROPENUMPROCEXA), lParam (LPARAM)
r1, _, err := procEnumPropsExA.Call(
uintptr(hWnd),
uintptr(lpEnumFunc),
uintptr(lParam),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction EnumPropsExA(
hWnd: THandle; // HWND
lpEnumFunc: Pointer; // PROPENUMPROCEXA
lParam: NativeInt // LPARAM
): Integer; stdcall;
external 'USER32.dll' name 'EnumPropsExA';result := DllCall("USER32\EnumPropsExA"
, "Ptr", hWnd ; HWND
, "Ptr", lpEnumFunc ; PROPENUMPROCEXA
, "Ptr", lParam ; LPARAM
, "Int") ; return: INT●EnumPropsExA(hWnd, lpEnumFunc, lParam) = DLL("USER32.dll", "int EnumPropsExA(void*, void*, int)")
# 呼び出し: EnumPropsExA(hWnd, lpEnumFunc, lParam)
# hWnd : HWND -> "void*"
# lpEnumFunc : PROPENUMPROCEXA -> "void*"
# lParam : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn EnumPropsExA(
hWnd: ?*anyopaque, // HWND
lpEnumFunc: ?*anyopaque, // PROPENUMPROCEXA
lParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) i32;proc EnumPropsExA(
hWnd: pointer, # HWND
lpEnumFunc: pointer, # PROPENUMPROCEXA
lParam: int # LPARAM
): int32 {.importc: "EnumPropsExA", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
int EnumPropsExA(
void* hWnd, // HWND
void* lpEnumFunc, // PROPENUMPROCEXA
ptrdiff_t lParam // LPARAM
);ccall((:EnumPropsExA, "USER32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}, Int),
hWnd, lpEnumFunc, lParam)
# hWnd : HWND -> Ptr{Cvoid}
# lpEnumFunc : PROPENUMPROCEXA -> Ptr{Cvoid}
# lParam : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t EnumPropsExA(
void* hWnd,
void* lpEnumFunc,
intptr_t lParam);
]]
local user32 = ffi.load("user32")
-- user32.EnumPropsExA(hWnd, lpEnumFunc, lParam)
-- hWnd : HWND
-- lpEnumFunc : PROPENUMPROCEXA
-- lParam : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const EnumPropsExA = lib.func('__stdcall', 'EnumPropsExA', 'int32_t', ['void *', 'void *', 'intptr_t']);
// EnumPropsExA(hWnd, lpEnumFunc, lParam)
// hWnd : HWND -> 'void *'
// lpEnumFunc : PROPENUMPROCEXA -> 'void *'
// lParam : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("USER32.dll", {
EnumPropsExA: { parameters: ["pointer", "pointer", "isize"], result: "i32" },
});
// lib.symbols.EnumPropsExA(hWnd, lpEnumFunc, lParam)
// hWnd : HWND -> "pointer"
// lpEnumFunc : PROPENUMPROCEXA -> "pointer"
// lParam : LPARAM -> "isize"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t EnumPropsExA(
void* hWnd,
void* lpEnumFunc,
intptr_t lParam);
C, "USER32.dll");
// $ffi->EnumPropsExA(hWnd, lpEnumFunc, lParam);
// hWnd : HWND
// lpEnumFunc : PROPENUMPROCEXA
// 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.ASCII_OPTIONS);
int EnumPropsExA(
Pointer hWnd, // HWND
Callback lpEnumFunc, // PROPENUMPROCEXA
long lParam // LPARAM
);
}@[Link("user32")]
lib LibUSER32
fun EnumPropsExA = EnumPropsExA(
hWnd : Void*, # HWND
lpEnumFunc : Void*, # PROPENUMPROCEXA
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 EnumPropsExANative = Int32 Function(Pointer<Void>, Pointer<Void>, IntPtr);
typedef EnumPropsExADart = int Function(Pointer<Void>, Pointer<Void>, int);
final EnumPropsExA = DynamicLibrary.open('USER32.dll')
.lookupFunction<EnumPropsExANative, EnumPropsExADart>('EnumPropsExA');
// hWnd : HWND -> Pointer<Void>
// lpEnumFunc : PROPENUMPROCEXA -> Pointer<Void>
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function EnumPropsExA(
hWnd: THandle; // HWND
lpEnumFunc: Pointer; // PROPENUMPROCEXA
lParam: NativeInt // LPARAM
): Integer; stdcall;
external 'USER32.dll' name 'EnumPropsExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "EnumPropsExA"
c_EnumPropsExA :: Ptr () -> Ptr () -> CIntPtr -> IO Int32
-- hWnd : HWND -> Ptr ()
-- lpEnumFunc : PROPENUMPROCEXA -> Ptr ()
-- lParam : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let enumpropsexa =
foreign "EnumPropsExA"
((ptr void) @-> (ptr void) @-> intptr_t @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* lpEnumFunc : PROPENUMPROCEXA -> (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 ("EnumPropsExA" enum-props-ex-a :convention :stdcall) :int32
(h-wnd :pointer) ; HWND
(lp-enum-func :pointer) ; PROPENUMPROCEXA
(l-param :int64)) ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $EnumPropsExA = Win32::API::More->new('USER32',
'int EnumPropsExA(HANDLE hWnd, LPVOID lpEnumFunc, LPARAM lParam)');
# my $ret = $EnumPropsExA->Call($hWnd, $lpEnumFunc, $lParam);
# hWnd : HWND -> HANDLE
# lpEnumFunc : PROPENUMPROCEXA -> LPVOID
# lParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。関連項目
文字セット違い
- f EnumPropsExW (Unicode版) — ウィンドウのプロパティを拡張コールバックで列挙する(Unicode版)。
類似 API
- f EnumPropsA — ウィンドウのプロパティをコールバックで列挙する(ANSI版)。
使用する型