GetRootCategories Method (CatalogSearchOptions, Int32)

NOTE: This API is now obsolete.

(Obsolete) Root products and categories are obsolete, Use GetRootCategory instead. Returns the root categories that match the search options for the current instance.

Namespace:  Microsoft.CommerceServer.Catalog
Assembly:  Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)

Syntax

'Declaration
<ObsoleteAttribute("Root products and categories are obsolete, use GetRootCategory() instead")> _
Public Function GetRootCategories ( _
    searchOptions As CatalogSearchOptions, _
    <OutAttribute> ByRef totalRecords As Integer _
) As CatalogItemsDataSet
'Usage
Dim instance As ProductCatalog
Dim searchOptions As CatalogSearchOptions
Dim totalRecords As Integer
Dim returnValue As CatalogItemsDataSet

returnValue = instance.GetRootCategories(searchOptions, _
    totalRecords)
[ObsoleteAttribute("Root products and categories are obsolete, use GetRootCategory() instead")]
public CatalogItemsDataSet GetRootCategories(
    CatalogSearchOptions searchOptions,
    out int totalRecords
)
[ObsoleteAttribute(L"Root products and categories are obsolete, use GetRootCategory() instead")]
public:
CatalogItemsDataSet^ GetRootCategories(
    CatalogSearchOptions^ searchOptions, 
    [OutAttribute] int% totalRecords
)
public function GetRootCategories(
    searchOptions : CatalogSearchOptions, 
    totalRecords : int
) : CatalogItemsDataSet

Parameters

  • totalRecords
    Type: System..::.Int32%
    The total number of records matching the query.

Return Value

Type: Microsoft.CommerceServer.Catalog..::.CatalogItemsDataSet
A CatalogItemsDataSet containing the root categories for the current instance.

Remarks

The multilingual information for the root categories will be in the current ActiveLanguage of the catalog. The returned dataset will contain all one row for each root category in the catalog. The dataset will contain all the properties in the catalog.

Permissions

See Also

Reference

ProductCatalog Class

ProductCatalog Members

GetRootCategories Overload

Microsoft.CommerceServer.Catalog Namespace