PSFormatForDisplay 関数 (propsys.h)
PROPVARIANT 構造体に格納されているプロパティ値の書式設定された Unicode 文字列表現を取得します。 呼び出し元は、出力バッファーの割り当てを担当します。
構文
PSSTDAPI PSFormatForDisplay(
[in] REFPROPERTYKEY propkey,
[in] REFPROPVARIANT propvar,
[in] PROPDESC_FORMAT_FLAGS pdfFlags,
[out] LPWSTR pwszText,
[in] DWORD cchText
);
パラメーター
[in] propkey
型: REFPROPERTYKEY
値が取得されるプロパティに名前を付ける PROPERTYKEY への参照。
[in] propvar
型: REFPROPVARIANT
プロパティの型と値を含む PROPVARIANT 構造体への参照。
[in] pdfFlags
プロパティ文字列に適用する形式を指定するフラグ。 使用可能な値については 、「PROPDESC_FORMAT_FLAGS 」を参照してください。
[out] pwszText
種類: LPWSTR
関数が戻るとき、 には、null で終わる Unicode 文字列として書式設定された値へのポインターが含まれます。 呼び出し元のアプリケーションは、 PSFormatForDisplay を呼び出す前にバッファーのメモリを割り当てる役割を担います。
[in] cchText
型: DWORD
WCHARs の pwszText にあるバッファーの長さを指定します 。終端の null 文字も含まれます。
戻り値
種類: HRESULT
次のいずれかの値を返します。
| リターン コード | 説明 |
|---|---|
|
書式設定された文字列が正常に作成されました。 |
|
書式設定された文字列が作成されませんでした。 S_FALSEは、空の文字列がVT_EMPTYの結果であることを示します。 |
|
割り当てが失敗したことを示します。 |
注釈
この関数は、スキーマ サブシステムの IPropertySystem::FormatForDisplay の実装を呼び出します。 この呼び出しにより、プロパティ値の Unicode 文字列表現が提供され、1 つ以上の PROPDESC_FORMAT_FLAGSに基づいて書式設定が追加されます。 PROPERTYKEY がスキーマ サブシステムによって認識されない場合、IPropertySystem::FormatForDisplay は値の VARTYPE に従って値の書式設定を試みます。
PSFormatPropertyValue を呼び出す前に、CoInitialize または OleInitialize を使用してコンポーネント オブジェクト モデル (COM) を初期化する必要があります。
この関数の目的は、データをユーザーへの表示に適した文字列に変換することです。 値は、現在のロケール、ユーザーの言語、 PROPDESC_FORMAT_FLAGS、およびプロパティ キーで指定されたプロパティの説明に従って書式設定されます。 プロパティ記述スキーマが値の書式設定にどのように影響するかについては、次のトピックを参照してください。
通常、 PROPDESC_FORMAT_FLAGS は、プロパティの説明で規定されている形式を変更するために使用されます。出力文字列には Unicode 方向文字を含めることができます。 これらの非スペーシング文字は Unicode 双方向アルゴリズムに影響を与え、左から右 (LTR) 言語が右から左 (RTL) ウィンドウに描画されたとき、または RTL が LTR ウィンドウに描画されたときに値が正しく表示されるようにします。 これらの文字には、次のものが含まれます。 "\x200e", "\x200f", "\x202a", "\x202b", "\x202c", "\x202d", "\x202e".
次のプロパティは特殊な形式を使用し、 PROPDESC_FORMAT_FLAGSの影響を受けません。 引用されている例は、現在のロケールが英語に設定されている文字列に対するものです。通常、出力は、記載されている場合を除いてローカライズされます。
| プロパティ | Format |
|---|---|
| System.FileAttributes | 次のファイル属性は文字に変換され、文字列を作成するために追加されます (たとえば、0x1801 の値は "RCO" に変換されます)。 |
| FILE_ATTRIBUTE_READONLY- 'R' | |
| FILE_ATTRIBUTE_SYSTEM - 'S' | |
| FILE_ATTRIBUTE_ARCHIVE -'A' | |
| FILE_ATTRIBUTE_COMPRESSED - 'C' | |
| FILE_ATTRIBUTE_ENCRYPTED - 'E' | |
| FILE_ATTRIBUTE_OFFLINE - 'O' | |
| FILE_ATTRIBUTE_NOT_CONTENT_INDEXED - 'I' | |
| 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" などです。 |
プロパティ キーが登録されているプロパティ スキーマのプロパティの説明に対応していない場合、この関数は値の型に基づいて形式を選択します。
| 値の型 | フォーマット |
|---|---|
| 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 |何か | セミコロンで区切られた値。 セミコロンは、ロケールに関係なく使用されます。 |
例
次の例は、より大きなプログラムの一部として含めるために、 PSFormatForDisplay を使用して評価値を書式設定する方法を示しています。
PROPVARIANT propvar;
HRESULT hr = InitPropVariantFromUInt32(RATING_THREE_STARS_SET, &propvar);
if (SUCCEEDED(hr))
{
WCHAR szValue[100];
hr = PSFormatForDisplay(PKEY_Rating, propvar, PDFF_DEFAULT, szValue, ARRAYSIZE(szValue));
if (SUCCEEDED(hr))
{
// szValue contains a formatted string similar to "3 stars".
}
PropVariantClear(&propvar);
}
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | propsys.h |
| Library | Propsys.lib |
| [DLL] | Propsys.dll (バージョン 6.0 以降) |
| 再頒布可能パッケージ | Windows デスクトップ検索 (WDS) 3.0 |