ICategory3::get_ChildCategories Property [C++]

Article
11/12/2009

The ChildCategories property is a read-only Recordset object that contains the names of categories that exist below this category in the hierarchy.

Definition

[C++]

HRESULT ICategory3::get_ChildCategories(_Recordset**ChildCategories);

[Visual Basic]

Property ChildCategories As Recordset

Parameters

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

[Visual Basic] None.

[C++]

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully.

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_RS_POINTER	[C++] 0x889800B7 [Visual Basic] &H889800B7	The recordset pointer that you specified is invalid

E_CAT_INVALID_RS_POINTER

[C++] 0x889800B7

[Visual Basic] &H889800B7

The recordset pointer that you specified is invalid

Remarks

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

[Visual Basic] The ChildCategories property contains valid data only if the property is accessed successfully.

The ChildCategories property recordset contains a row for each of the categories that are currently children of this category. The following table lists the fields for the ChildCategories property recordset.

Field	Data Type	Description
CategoryName	String maximum of 128 characters	The name of the category.
DefinitionName	String maximum of 128 characters	The name of the definition.
CatalogName	String maximum of 128 characters	The name of the catalog that contains the category.
DisplayName	String maximum of 128 characters	The display name of the category.

If this category object has no children, an empty recordset is returned whose EOF property is set to VARIANT_TRUE. Your code should check the value of this property to determine if child categories exist.