IPropertyDescription::FormatForDisplay メソッド (propsys.h)

プロパティ値の書式設定された Unicode 文字列表現を取得します。

構文

HRESULT FormatForDisplay(
  [in]  REFPROPVARIANT        propvar,
  [in]  PROPDESC_FORMAT_FLAGS pdfFlags,
  [out] LPWSTR                *ppszDisplay
);

パラメーター

[in] propvar

型: REFPROPVARIANT

プロパティの型と値を含む PROPVARIANT 構造体への参照。

[in] pdfFlags

種類: PROPDESC_FORMAT_FLAGS

プロパティ文字列形式を示す 1 つ以上の PROPDESC_FORMAT_FLAGS フラグ (ビットごとの値または複数の値)。

[out] ppszDisplay

種類: LPWSTR*

表示テキストを含む null で終わる Unicode 文字列へのポインターのアドレス。

戻り値

種類: HRESULT

次のいずれかの値を返します。

注釈

IPropertyDescription::FormatForDisplay を呼び出す前に、CoInitialize または OleInitialize を使用してコンポーネント オブジェクト モデル (COM) を初期化する必要があります。

成功すると、このメソッドは、指定された PROPERTYKEY のプロパティ値の書式設定された Unicode 文字列表現を取得し、1 つ以上 のPROPDESC_FORMAT_FLAGS。

このメソッドの目的は、データをユーザーに表示するのに適した文字列に変換することです。 値は、現在のロケール、ユーザーの言語、 PROPDESC_FORMAT_FLAGS、およびプロパティ キーで指定されたプロパティの説明に従って書式設定されます。 プロパティ記述スキーマが値の書式設定にどのように影響するかについては、「 displayInfo、 stringFormat、 booleanFormat、 numberFormat、 NMDATETIMEFORMAT、および enumeratedList」を参照してください。 通常、 PROPDESC_FORMAT_FLAGS は、プロパティの説明で規定されている形式を変更するために使用されます。

出力文字列には Unicode 方向文字を含めることができます。 これらの非スペーシング文字は Unicode 双方向アルゴリズムに影響を与え、左から右 (LTR) 言語が右から左 (RTL) ウィンドウに描画されるときに値が正しく表示されるようにします。その逆も同様です。 これらの文字には、次のものが含まれます。 "\x200e", "\x200f", "\x202a", "\x202b", "\x202c", "\x202d", "\x202e".

次のプロパティは特殊な形式を使用し、 PROPDESC_FORMAT_FLAGS の影響を受けません (引用例は、現在のロケールが英語に設定されている文字列の場合です。通常、出力は記載されている場合を除いてローカライズされます)。

要件

こちらもご覧ください

IPropertyDescription

プロパティの説明スキーマ