Share via


IPropertyDescription::GetSortDescriptionLabel 方法 (propsys.h)

取得描述目前排序順序的當地語系化顯示字串。

語法

HRESULT GetSortDescriptionLabel(
  [in]  BOOL   fDescending,
  [out] LPWSTR *ppszDescription
);

參數

[in] fDescending

類型: BOOL*

如果 ppszDescription 應該參考 “Z on top” 字串,則為 TRUE;FALSE 表示參考字串 「A on top」。。

[out] ppszDescription

類型: LPWSTR*

當這個方法傳回時,會包含排序描述的指標位址,做為 Null 終止的 Unicode 字串。

傳回值

類型: HRESULT

如果此方法成功,則會傳回 S_OK。 否則,它會傳回 HRESULT 錯誤碼。

備註

這個方法所擷取的字串是由屬性 .propdesc 檔案中 labelInfo 元素 sortDescription 屬性中所設定的旗標所決定。

當不再需要 ppszDescription 時,呼叫應用程式必須負責釋放 ppszDescription

規格需求

需求
最低支援的用戶端 Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2008 [僅限傳統型應用程式]
目標平台 Windows
標頭 propsys.h

另請參閱

IPropertyDescription

屬性描述架構