ICategorizer::GetDescription method (shobjidl_core.h)

Article
02/22/2024

Gets the name of a categorizer, such as Group By Device Type, that can be displayed in the UI.

Syntax

HRESULT GetDescription(
  [out] LPWSTR pszDesc,
  [in]  UINT   cch
);

Parameters

[out] pszDesc

Type: LPWSTR

When this method returns, contains a pointer to a string of length cch that contains the categorizer name.

[in] cch

Type: UINT

The number of characters in the pszDesc buffer.

Return value

Type: HRESULT

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

Remarks

In the case of the system folder view object, if the description at pszDesc matches one of the category names listed in the folder's Arrange Icons By menu, a dot is placed by that name when the menu is displayed, either through the View menu or through the context menu.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)
DLL	Shell32.dll

Share via