GetChildCategories Method (CatalogSearchOptions, Boolean, Int32)

NOTE: This API is now obsolete.

(Obsolete) Retrieve a DataSet containing the child categories of this category using the searchOptions parameter to determine how the results are returned. A recursive search and the total number of returned records are available.

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

Syntax

'Declaration
<ObsoleteAttribute("Category.GetChildCategories has been replaced by Category.ChildCategories")> _
Public Function GetChildCategories ( _
    searchOptions As CatalogSearchOptions, _
    recursive As Boolean, _
    <OutAttribute> ByRef totalRecords As Integer _
) As DataSet
'Usage
Dim instance As Category
Dim searchOptions As CatalogSearchOptions
Dim recursive As Boolean
Dim totalRecords As Integer
Dim returnValue As DataSet

returnValue = instance.GetChildCategories(searchOptions, _
    recursive, totalRecords)
[ObsoleteAttribute("Category.GetChildCategories has been replaced by Category.ChildCategories")]
public DataSet GetChildCategories(
    CatalogSearchOptions searchOptions,
    bool recursive,
    out int totalRecords
)
[ObsoleteAttribute(L"Category.GetChildCategories has been replaced by Category.ChildCategories")]
public:
DataSet^ GetChildCategories(
    CatalogSearchOptions^ searchOptions, 
    bool recursive, 
    [OutAttribute] int% totalRecords
)
public function GetChildCategories(
    searchOptions : CatalogSearchOptions, 
    recursive : boolean, 
    totalRecords : int
) : DataSet

Parameters

  • recursive
    Type: System..::.Boolean
    A value that indicates whether to include child categories recursively.
  • totalRecords
    Type: System..::.Int32%
    Returns the number of total records matching the search options excluding paging.

Return Value

Type: System.Data..::.DataSet
The DataSet contains a DataTable with the child category property data that match the search criteria.

Remarks

A recursive value of true indicates that the search is recursive; otherwise false. The totalRecords indicate the number of records returned.

A CatalogSearchOptions object can be provided to catalog methods that perform a database search to specify which records to return, how to sort the result set, and so on. Note that not all methods respect all of the settings. When the site is run in Debug mode or Checked mode, a warning message will be logged to the active DebugContext object whenever a setting has been made that cannot be respected.

GetChildCategories has been replaced by Category.ChildCategories.

Permissions

See Also

Reference

Category Class

Category Members

GetChildCategories Overload

Microsoft.CommerceServer.Catalog Namespace