ICategory3::get_RelatedCategories Property [C++]

Article
11/12/2009

The RelatedCategories property is a read-only recordset that contains all categories in the Product Catalog System related to this category.

Definition

[C++]

HRESULT ICategory3::get_RelatedCategories(_Recordset**RelatedCategories);

[Visual Basic]

Property RelatedCategories As Recordset

Parameters

RelatedCategories[C++]
[out, retval] A _Recordset object used to return the related categories.

[Visual Basic] None.

[C++]

Return Values

This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

The following table describes the custom COM errors this method can return.

Constant	Value	Description
E_CAT_INVALID_OPERATION_FOR_ROOT_CATEGORY	[C++] 0x889800F8 [Visual Basic] &H889800F8	This API cannot be called for a root category.
E_CAT_INVALID_RS_POINTER	[C++] 0x889800B7 [Visual Basic] &H889800B7	The recordset pointer that you specified is invalid.

E_CAT_INVALID_OPERATION_FOR_ROOT_CATEGORY

[C++] 0x889800F8

[Visual Basic] &H889800F8

This API cannot be called for a root category.

E_CAT_INVALID_RS_POINTER

[C++] 0x889800B7

[Visual Basic] &H889800B7

The recordset pointer that you specified is invalid.

Remarks

[C++] The RelatedCategories parameter contains valid data only if the property is accessed successfully.

The RelatedCategories property contains information on all the relationships this category has to other categories. The recordset returned contains one row for each relationship present.

The following table shows the fields in the returned recordset.

Field	Data Type	Description
CategoryName	String maximum of 128 characters	The name of the category.
RelationshipName	String maximum of 128 characters	The name of the relationship.
RelationshipDescription	String maximum of 256 characters	The description of the relationship.
TargetCatalog	String maximum of 128 characters	The name of the target catalog.