ICatInformation::GetCategoryDesc

  • Article

This method retrieves the localized description string for a specific category identifier.

HRESULT GetCategoryDesc(
  REFCATID rcatid, 
  LCID lcid, 
  PWCHAR* ppszDesc 
);

Parameters

  • rcatid
    [in] Category for which the description string is to be returned.
  • lcid
    [in] Locale in which the resulting string is returned.
  • ppszDesc
    [out] Pointer to the string pointer that contains the description. This must be released by the caller using CoTaskMemFree.

Return Values

The following table shows the return values for this method.

Value Description
S_OK The function was successful.
E_INVALIDARG One or more arguments are incorrect.
E_OUTOFMEMORY Insufficient memory to create and return an enumerator object.
CAT_E_CATIDNOEXIST The category identifier rcatid is not registered.
CAT_E_NODESCRIPTION There is no description string for rcatid with the specified locale.

Remarks

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Requirements

OS Versions: Windows CE 3.0 and later.
Header: Comcat.h, Comcat.idl.
Link Library: Ole32.lib, Uuid.lib.

See Also

ICatInformation::EnumCategories | ICatInformation::EnumClassesOfCategories | ICatInformation::EnumImplCategoriesOfClass | ICatInformation::EnumReqCategoriesOfClass | ICatInformation::IsClassOfCategories

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.