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

一个标志，指定要应用于属性字符串的格式。 有关可能的值 ，请参阅PROPDESC_FORMAT_FLAGS 。

[out] pwszText

类型： LPWSTR

当函数返回时，包含指向格式化值的指针，作为以 null 结尾的 Unicode 字符串。 调用应用程序负责在调用 PSFormatForDisplay 之前为缓冲区分配内存。

[in] cchText

类型：DWORD

指定 WCHAR 中 pwszText 处缓冲区的长度，包括终止 null 字符。

返回值

类型： HRESULT

返回以下值之一。

返回代码	说明
S_OK	已成功创建格式化字符串。
S_FALSE	未创建带格式的字符串。 S_FALSE指示空字符串来自VT_EMPTY。
E_OUTOFMEMORY	指示分配失败。

注解

此函数调用架构子系统的 IPropertySystem：：FormatForDisplay 实现。 该调用提供属性值的 Unicode 字符串表示形式，以及基于一个或多个 PROPDESC_FORMAT_FLAGS的其他格式。 如果架构子系统无法识别 PROPERTYKEY ， 则 IPropertySystem：：FormatForDisplay 将尝试根据值的 VARTYPE 设置值的格式。

在调用 PSFormatPropertyValue 之前，必须使用 CoInitialize 或 OleInitialize 初始化组件对象模型 (COM) 。

此函数的目的是将数据转换为适合向用户显示的字符串。 根据当前区域设置、用户语言、 PROPDESC_FORMAT_FLAGS以及属性键指定的属性说明设置值的格式。 有关属性说明架构如何影响值格式的信息，请参阅以下主题：

• displayInfo
• stringFormat
• booleanFormat
• numberFormat
• NMDATETIMEFORMAT
• enumeratedList

通常， PROPDESC_FORMAT_FLAGS 用于修改属性说明规定的格式。

输出字符串可以包含 Unicode 方向字符。 这些非节奏字符会影响 Unicode 双向算法，以便在从右到右 (LTR) 语言在从右到左 (RTL) 窗口中绘制时，或者在 LTR 窗口中绘制 RTL 时，值正确显示。 这些字符包括： "\x200e", "\x200f", "\x202a", "\x202b", "\x202c", "\x202d", "\x202e".

以下属性使用特殊格式，不受 PROPDESC_FORMAT_FLAGS影响。 请注意，引用的示例适用于当前区域设置设置为英语的字符串;通常，输出是本地化的，除非另有规定。

属性	格式
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 值转换为曝光时间： Exposure_time = 2^(-APEX_value) 例如，“2 秒”。或“1/125 秒”。
System.Photo.ExposureTime	例如，“2 秒”。或“1/125 秒”。
System.Photo.Aperture	使用以下公式将 APEX 值转换为 F 数字： F_Number = 2^(APEX_Value / 2) 例如，“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	例如，“应用程序”或“JPEG 映像”。
System.ControlPanel.Category	例如，“外观和个性化”。
System.ComputerName	例如，“LITWARE05 (此计算机) ”或“testbox07”。

 

如果属性键不对应于任何已注册属性架构中的属性说明，则此函数将根据值的类型选择格式。

值的类型	格式
VT_BOOLEAN	不支持。
VT_FILETIME	PROPDESC_FORMAT_FLAGS和当前区域设置指定的日期/时间字符串。 默认PDFF_SHORTTIME和PDFF_SHORTDATE。 例如，“2006/11/13 3：22 PM”。
数字 VARTYPE	当前区域设置中的十进制字符串。 例如，“42”。
VT_LPWSTR或其他	转换为字符串。 “\r”、“\t”或“\n”序列将替换为单个空格。
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

另请参阅

PSFormatForDisplayAlloc

PSFormatPropertyValue

属性说明架构