ホーム › UI.WindowsAndMessaging › PROPENUMPROCA

PROPENUMPROCA

コールバック

シグネチャ

BOOL PROPENUMPROCA(
    HWND param0,
    LPSTR param1,
    HANDLE param2
);

パラメーター

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

公式ドキュメント

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

戻り値

型: BOOL

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

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

解説(Remarks)

メモ

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

このコールバック関数には、次の制限が適用されます。

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

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして PROPENUMPROC を定義しています。エンコードに依存しないこのエイリアスを、エンコードに依存するコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因になることがあります。詳しくは、関数プロトタイプの規則を参照してください。

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