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
WCHARs 中 pszText 的緩衝區長度,包括終止 NULL。 大小上限為 0x8000 (32K) 。
傳回值
類型: HRESULT
傳回下列其中一個值。
傳回碼 | 描述 |
---|---|
|
已建立格式化字串。 |
|
未建立格式化字串。 S_FALSE表示空字串是由VT_EMPTY所產生。 |
|
記憶體配置失敗。 |
備註
您必須使用 CoInitialize 或 OleInitialize 初始化元件物件模型 (COM) ,才能呼叫 IPropertySystem::FormatForDisplay。
成功時,這個方法會取得指定 PROPERTYKEY 屬性值的格式化 Unicode 字串表示,以及一或多個 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 ( 範例影響,適用於目前地區設定設定為英文的字串;一般而言,輸出會當地語系化,但未) 。
屬性 | [格式] |
---|---|
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 sec.」。。 |
System.Photo.ExposureTime | 例如,“2 秒”。或 「1/125 sec」。。 |
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 step”、“0 step” 或 “+3 step”。 |
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 | 目前地區設定中的十進位字串。 例如,“42”。 |
VT_LPWSTR或其他 | 字串。 “\r”、“\t” 或 “\n” 序列會取代為單一空格。 |
VT_VECTOR |什麼 | 分號分隔值—不論地區設定為何,都會使用分號。 |
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | propsys.h |
可轉散發套件 | Windows 桌面搜尋 (WDS) 3.0 |