Share via

ProductCatalog.GetRootCategories (CatalogSearchOptions, Int32) Method (BCL)

  • Article

Use this method to return the properties of the root categories of this catalog and return results according to the searchOptions parameter, and to return the total number of root products in the catalog in the totalRecords parameter.

Definition

[Visual Basic .NET]

Overridable Public Function GetRootCategories( _ByValsearchOptions As CatalogSearchOptions, _
  ByReftotalRecords As System.Int32 _
) As System.Data.DataSet

[C#]

public virtual System.Data.DataSet GetRootCategories(CatalogSearchOptionssearchOptions,
  out System.Int32totalRecords);

Parameters

[Visual Basic .NET]

  • searchOptions
    The CatalogSearchOptions object. May be null.
  • totalRecords
    The total number of root products.

[C#]

  • searchOptions
    The CatalogSearchOptions object. May be null.
  • totalRecords
    The total number of root products.

Return Value

A DataSet with a single DataTable containing the root categories.

Remarks

Throws a CatalogException on failure.

Requirements

Namespace: Microsoft.CommerceServer.Runtime.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: Microsoft.CommerceServer.Runtime.dll

Copyright © 2005 Microsoft Corporation.
All rights reserved.