FormatPropertyInstance 関数は、Network Monitor が提供する汎用フォーマッタを使用して、プロパティ インスタンス データの書式を設定します。
構文
DWORD WINAPIV FormatPropertyInstance(
_Inout_ LPPROPERTYINST lpPropertyInst
);
パラメーター
-
lpPropertyInst [in, out]
-
インスタンス データを含む PROPERTYINST 構造体へのポインター。
入力時に、ジェネリック フォーマッタは PROPERTYINST 共用体メンバーの 1 つからインスタンス データを受け取り、そのデータを定義済みの書式設定された文字列に変換します。
出力時に、汎用フォーマッタは PROPERTYINST 構造体の szPropertyText メンバーを書式設定された文字列へのポインターに設定します。
戻り値
関数が成功した場合、戻り値はNMERR_SUCCESS。
関数が失敗した場合、戻り値は NMerr.h からのエラー コードです。
解説
汎用フォーマッタがネットワーク モニター UI の詳細ウィンドウに表示されるデータの書式設定に必要な場合、パーサー DLL は FormatPropertyInstance 関数を間接的に呼び出します。 FormatPropertyInstance を呼び出すには、 プロパティを定義するときに PROPERTYINFO 構造体の InstanceData メンバーで指定します。
Note
パーサーは、プロパティのインスタンスを書式設定する必要がある場合に呼び出される関数を認識しません。 関数には、 FormatPropertyInstance またはパーサーによって定義されたカスタム書式関数を指定できます。 パーサーは、 プロパティの PROPERTYINFO 構造体の InstanceData メンバーによって指定された書式関数を呼び出します。
書式プロパティを実装する方法の詳細と例については、「 FormatProperties の 実装」を参照してください。 ジェネリック フォーマッタでさまざまな種類のデータを書式設定する方法の詳細については、「 汎用フォーマッタ出力」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows 2000 Server [デスクトップ アプリのみ] |
| ヘッダー |
|
| ライブラリ |
|
| [DLL] |
|