ICatInformation::GetCategoryDesc method (comcat.h)

Retrieves the localized description string for a specific category ID.

Syntax

HRESULT GetCategoryDesc(
  [in]  REFCATID rcatid,
  [in]  LCID     lcid,
  [out] LPWSTR   *pszDesc
);

Parameters

[in] rcatid

The category identifier.

[in] lcid

The locale.

[out] pszDesc

A pointer to the string pointer for the description. This string must be released by the caller using the CoTaskMemFree function.

Return value

This method can return the standard return values E_INVALIDARG, E_OUTOFMEMORY, and S_OK, as well as the following values.

Return code	Description
CAT_E_CATIDNOEXIST	The category ID rcatid is not registered.
CAT_E_NODESCRIPTION	There is no description string for rcatid with the specified locale.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	comcat.h

See also

ICatInformation