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 」を参照してください。
[out] pszText
種類: LPWSTR
書式設定された値を null で終わる Unicode 文字列として受け取ります。 呼び出し元のアプリケーションは、バッファーのメモリを割り当てる必要があります。
[in] cchText
型: DWORD
終端の NULL を含む、WCHARs の pszText のバッファーの長さ。 最大サイズは0x8000 (32K) です。
戻り値
型: HRESULT
次のいずれかの値を返します。
| リターン コード | 説明 |
|---|---|
|
書式設定された文字列が作成されます。 |
|
書式設定された文字列は作成されません。 S_FALSEは、空の文字列がVT_EMPTYの結果であることを示します。 |
|
メモリの割り当てが失敗しました。 |
注釈
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 の影響を受けません (引用例は、現在のロケールが英語に設定されている文字列の場合です。通常、出力は特記されている場合を除きローカライズされます)。
| プロパティ | Format |
|---|---|
| System.FileAttributes | 次のファイル属性は、文字に変換され、文字列を作成するために追加されます (たとえば、0x1801の値 (FILE_ATTRIBUTE_READONLY |FILE_ATTRIBUTE_COMPRESSED |FILE_ATTRIBUTE_OFFLINE) は "RCO" に変換されます。
|
| System.Photo.ISOSpeed | たとえば、"ISO-400" とします。 |
| System.Photo.ShutterSpeed |
APEX 値は、次の数式を使用して露出時間に変換されます。
たとえば、"2 秒" とします。または "1/125 秒"。 |
| System.Photo.ExposureTime | たとえば、"2 秒" とします。または "1/125 秒" です。 |
| System.Photo.Aperture |
APEX 値は、次の数式を使用して F 数値に変換されます。
たとえば、"f/5.6" とします。 |
| System.Photo.FNumber | たとえば、"f/5.6" とします。 |
| System.Photo.SubjectDistance | たとえば、"15 m"、"250 mm" などです。 |
| System.Photo.FocalLength | たとえば、"50 mm" とします。 |
| System.Photo.FlashEnergy | たとえば、"500 bpcs" とします。 |
| System.Photo.ExposureBias | たとえば、"-2 ステップ"、"0 ステップ"、"+3 ステップ" などです。 |
| System.Computer.DecoratedFreeSpace | たとえば、"105 MB の空き 13.2 GB" などです。 |
| System.ItemType | たとえば、"Application" や "JPEG Image" などです。 |
| System.ControlPanel.Category | たとえば、"外観と個人用設定" などです。 |
| System.ComputerName | たとえば、"LITWARE05 (このコンピューター)" や "testbox07" などです。 |
プロパティ キーが、登録されているプロパティ スキーマのプロパティの説明に対応していない場合、このメソッドは、次の表で説明するように、値の種類に基づいて形式を選択します。
| 値の型 | Format |
|---|---|
| VT_BOOLEAN | サポートされていません。 |
| VT_FILETIME | PROPDESC_FORMAT_FLAGSと現在のロケールで指定された日付/時刻文字列。 PDFF_SHORTTIMEとPDFF_SHORTDATEが既定値です。 たとえば、"11/13/2006 3:22 PM" などです。 |
| 数値 VARTYPE | 現在のロケールの 10 進文字列。 たとえば、"42" とします。 |
| VT_LPWSTRまたはその他 | 文字列。 "\r"、"\t"、または "\n" のシーケンスは、1 つのスペースに置き換えられます。 |
| VT_VECTOR |何か | セミコロンで区切られた値 - ロケールに関係なくセミコロンが使用されます。 |
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | propsys.h |
| 再頒布可能パッケージ | Windows デスクトップ検索 (WDS) 3.0 |