ホーム › UI.WindowsAndMessaging › PROPENUMPROCEXA

PROPENUMPROCEXA

コールバック

シグネチャ

BOOL PROPENUMPROCEXA(
    HWND param0,
    LPSTR param1,
    HANDLE param2,
    UINT_PTR param3
);

パラメーター

フィールド	型	説明
param0	HWND	プロパティリストが列挙されるウィンドウのハンドルです。このパラメーターには通常 hWnd という名前が付けられます。
param1	LPSTR	プロパティリストエントリの文字列部分です。これは、SetProp 関数の呼び出しによってウィンドウのプロパティリストにプロパティが追加されたときに、データハンドルと共に指定された文字列です。このパラメーターには通常 lpString という名前が付けられます。
param2	HANDLE	データのハンドルです。このハンドルは、プロパティリストエントリのデータ部分です。このパラメーターには通常 hData という名前が付けられます。
param3	UINT_PTR	アプリケーション定義のデータです。これは、列挙を開始した EnumPropsEx の呼び出しで lParam パラメーターとして指定された値です。このパラメーターには通常 dwData という名前が付けられます。

公式ドキュメント

EnumPropsEx 関数と共に使用される、アプリケーション定義のコールバック関数です。この関数は、ウィンドウのプロパティリストからプロパティエントリを受け取ります。PROPENUMPROCEX 型は、このコールバック関数へのポインターを定義します。PropEnumProcEx は、アプリケーション定義の関数名を表すプレースホルダーです。

戻り値

型: BOOL

プロパティリストの列挙を続行するには TRUE を返します。

プロパティリストの列挙を停止するには FALSE を返します。

解説(Remarks)

メモ

パラメーターはヘッダー内で名前が付けられずに定義されています: typedef BOOL (CALLBACK* PROPENUMPROCEXA)(HWND, LPSTR, HANDLE, ULONG_PTR);。そのため、構文ブロックでは unnamedParam1 ～ unnamedParam4 として記載されています。アプリ内ではこれらのパラメーターに任意の名前を付けられますが、通常はパラメーターの説明に示されている名前が使用されます。

このコールバック関数には次の制限があります。

コールバック関数は RemoveProp 関数を呼び出すことができます。ただし、RemoveProp で削除できるのは、コールバック関数のパラメーターを通じてコールバック関数に渡されたプロパティだけです。
コールバック関数でプロパティを追加しようとしてはいけません。

メモ

winuser.h ヘッダーは PROPENUMPROCEX を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

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