Category3.DescendantProducts Property (PIA)
The DescendantProducts property is a read-only Recordset object that contains all products that exist anywhere below this category. Accessing this property on the root category returns every product in the entire catalog.
Definition
[Visual Basic .NET]
Imports Microsoft.CommerceServer.Interop.Catalog
…
Public Property DescendantProducts(Optional eClassTypeRequired As Object,
Optional lStartingRecord As Object,
Optional lRecordsToRetrieve As Object,
Optional plTotalRecordsInQuery As Integer) As _Recordset
[C#]
using Microsoft.CommerceServer.Interop.Catalog;
using ADODB26Lib; //For _Recordset
…
public _Recordset get_DescendantProducts(objecteClassTypeRequired,
objectlStartingRecord,
objectlRecordsToRetrieve,
ref objectplTotalRecordsInQuery);
Parameters
[Visual Basic .NET]
- eClassTypeRequired
An Object that contains the catalog class desired. Valid values are from the CatalogClassTypeEnum enumeration. For more information, see the Remarks section. - lStartingRecord
An Object that contains the starting record. - lRecordsToRetrieve
An Object that contains the number of records to retrieve. - plTotalRecordsInQuery
An Integer used to return the total number of records in the query.
[C#]
- eClassTypeRequired
An object that contains the catalog class desired. Valid values are from the CatalogClassTypeEnum enumeration. For more information, see the Remarks section. Set to Type.Missing in order to not specify a catalog class. - lStartingRecord
An object that contains the starting record. Set to Type.Missing in order to not specify a starting record. - lRecordsToRetrieve
An object that contains the number of records to retrieve. Set to Type.Missing in order to not specify the number or records to retrieve. - plTotalRecordsInQuery
An object used to return the total number of records in the query. Set the object to Type.Missing if the return value is not needed. - DescendantProducts
A _Recordset interface to the Recordset object used to return the descendant products.
Return Values
[C#] This method returns an ADODB26Lib._Recordset interface to a Recordset object used to return the descendant products.
Exceptions
This property may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.
The following table shows the custom COM errors that a COMException can wrap.
| Constant | Value | Description |
|---|---|---|
| E_CAT_INVALID_RS_POINTER | [C#] 0x889800B7
[Visual Basic .NET] &H889800B7 |
The recordset pointer that you specified is invalid |
Remarks
[C#]
The DescendantProducts parameter contains valid data only if the property is accessed successfully.
get_DescendantProducts does not show up in IntelliSense.
This property gets all the products that are directly or indirectly under this category.
The returned recordset contains all the fields in the CatalogProduct Recordset.
The following table shows the values of the CatalogClassTypeEnum enumeration, their associated names, and describes their use.
| Name | Value | Description |
|---|---|---|
| cscCategoryClass | 1 | Requests category data. |
| cscProductVariantClass | 2 | Requests product variant data. |
| cscProductClass | 4 | Requests product data. |
| cscProductFamilyClass | 8 | Requests product family data. |
| cscProductFamilyForVariantsClass | 16 | Requests family for variant data, which means the product family of a product variant is being requested. |
| cscProductVariantsForFamily | 32 | Requests variants for family data, which means that all of the product variants for a product family are being requested. |
CatalogClassTypeEnum values can be combined in the eClassTypeRequired parameter with logical OR operators, so that specifying cscProductClass OR cscProductVariantClass will return both product and product variant data.
Requirements
Namespace: Microsoft.CommerceServer.Interop.Catalog
Platforms: Windows 2000, Windows Server 2003
Assembly: cataloglib (in cataloglib.dll)
See Also
Copyright © 2005 Microsoft Corporation.
All rights reserved.