ICatInformation::GetCategoryDesc method

Retrieves the localized description string for a specific category ID.

Syntax


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

Parameters

rcatid [in]

The category identifier.

lcid [in]

The locale.

pszDesc [out]

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 codeDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

ComCat.h

IDL

ComCat.idl

IID

IID_ICatInformation is defined as 0002E013-0000-0000-C000-000000000046

See also

ICatInformation

 

 

Show: