Category.GetChildCategories (CatalogSearchOptions, Boolean) Method (BCL)

Article
11/12/2009

Use this method to get property data for the child categories of this category using the parameter to determine how the results are returned. . If the recursive value is true, the child categories of child categories of this category are also returned, as are the grandchild categories, the great-grandchild categories, and so on. In fact, all underlying recursive categories are returned.

Definition

[Visual Basic .NET]

Overridable Public Function GetChildCategories( _ByValsearchOptions As CatalogSearchOptions, _
  ByValrecursive As System.Boolean _
) As System.Data.DataSet

[C#]

public virtual System.Data.DataSet GetChildCategories(CatalogSearchOptionssearchOptions,
  System.Booleanrecursive);

Parameters

[Visual Basic .NET]

searchOptions
A CatalogSearchOptions object specifies how the data is to be returned. This value may be NULL.
recursive
A System.Boolean that indicates whether the search is recursive. A value of true indicates that the search is recursive.

[C#]

searchOptions
A CatalogSearchOptions object specifies how the data is to be returned. This value may be NULL.
recursive
A System.Boolean that indicates whether the search is recursive. A value of true indicates that the search is recursive.

Return Value

The DataSet contains a single DataTable with the child category property data.

Remarks

Calling the GetChildCategories method is more efficient than calling any of the GetChildCategories methods with parameters.

Throws a CatalogException on failure.

Because this method internally calls the Category.Search method, some error messages will report that the Search method has failed even though the Search method was not explicitly called.

Requirements

Namespace: Microsoft.CommerceServer.Runtime.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: Microsoft.CommerceServer.Runtime.dll

Share via