ICatInformation::GetCategoryDesc
Retrieves the localized description string for a specific category ID.
HRESULT GetCategoryDesc(
REFCATID rcatid,
|
//Category for which the string is to be returned
|
LCID lcid,
|
//Locale in which the resulting string is returned
|
PWCHAR* ppszDesc
|
//Pointer to the string pointer that contains the description
|
);
|
|
Parameters
-
rcatid
-
[in] Identifies the category for which the description string is to be
returned.
-
lcid
-
[in] Specifies the locale in which the resulting string is returned.
-
ppszDesc
-
[out] A pointer to the string pointer that contains the description. This must
be released by the caller using CoMemTaskFree.
Return Values
-
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 ID rcatid is not registered.
-
CAT_E_NODESCRIPTION
-
There is no description string for rcatid with the specified locale.
See Also
ICatInformation::EnumCategories,
ICatInformation::EnumClassesOfCategories,
ICatInformation::EnumImplCategoriesOfClass,
ICatInformation::EnumReqCategoriesOfClass,
ICatInformation::IsClassOfCategories