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

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

構文

HRESULT FormatForDisplay(
  [in]  REFPROPERTYKEY        key,
  [in]  REFPROPVARIANT        propvar,
  [in]  PROPDESC_FORMAT_FLAGS pdff,
  [out] LPWSTR                pszText,
  [in]  DWORD                 cchText
);

パラメーター

[in] key

型: REFPROPERTYKEY

要求された プロパティ キーへの参照。

[in] propvar

型: REFPROPVARIANT

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

[in] pdff

種類: PROPDESC_FORMAT_FLAGS

プロパティ文字列の形式。 使用可能な値については 、「PROPDESC_FORMAT_FLAGS 」を参照してください。

[out] pszText

種類: LPWSTR

書式設定された値を null で終わる Unicode 文字列として受け取ります。 呼び出し元のアプリケーションは、バッファーのメモリを割り当てる必要があります。

[in] cchText

型: DWORD

終端の NULL を含む、WCHARs の pszText のバッファーの長さ。 最大サイズは0x8000 (32K) です。

戻り値

型: HRESULT

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

注釈

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

成功すると、このメソッドは、指定された PROPERTYKEY のプロパティ値の書式設定された Unicode 文字列表現と、1 つ以上の PROPDESC_FORMAT_FLAGSを取得します。 PROPERTYKEY がスキーマ サブシステムによって認識されない場合、IPropertySystem::FormatForDisplay は VARTYPE に従って値の書式設定を試みます。

このメソッドの目的は、データをユーザーに表示するのに適した文字列に変換することです。 値は、現在のロケール、ユーザーの言語、 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 の影響を受けません (引用例は、現在のロケールが英語に設定されている文字列の場合です。通常、出力は特記されている場合を除きローカライズされます)。

プロパティ キーが、登録されているプロパティ スキーマのプロパティの説明に対応していない場合、このメソッドは、次の表で説明するように、値の種類に基づいて形式を選択します。

要件