ICatInformation::GetCategoryDesc (Compact 7)

  • Article

3/12/2014

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

Syntax

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 Value

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

There is 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

Header

comcat.h,
comcat.idl

Library

ole32.lib,
uuid.lib

See Also

Reference

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