IPropertyDescription::GetSortDescriptionLabel method (propsys.h)

Article
02/22/2024

Gets the localized display string that describes the current sort order.

Syntax

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

Parameters

[in] fDescending

Type: BOOL*

TRUE if ppszDescription should reference the string "Z on top"; FALSE to reference the string "A on top".

[out] ppszDescription

Type: LPWSTR*

When this method returns, contains the address of a pointer to the sort description as a null-terminated Unicode string.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The string retrieved by this method is determined by flags set in the sortDescription attribute of the labelInfo element in the property's .propdesc file.

It is the responsibility of the calling application to release ppszDescription when it is no longer needed.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	propsys.h