ホーム › UI.WindowsAndMessaging › PROPENUMPROCW

PROPENUMPROCW

コールバック

シグネチャ

BOOL PROPENUMPROCW(
    HWND param0,
    LPWSTR param1,
    HANDLE param2
);

パラメーター

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

公式ドキュメント

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

戻り値

Type: BOOL

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

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

解説(Remarks)

メモ

パラメーターはヘッダー内で名前を持たない形で定義されています: typedef BOOL (CALLBACK* PROPENUMPROCW)(HWND, LPCWSTR, HANDLE);。そのため、構文ブロックでは unnamedParam1 - unnamedParam3 として記載されます。アプリケーションではこれらのパラメーターに任意の名前を付けられますが、通常はパラメーターの説明に示した名前が使われます。

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

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

メモ

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

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