GetProducts Method (CatalogSearchOptions, Boolean)
NOTE: This API is now obsolete.
(Obsolete) Retrieve a DataSet containing the child products of this category using the searchOptions parameter to determine how the results are returned. A recursive search is available.
Namespace: Microsoft.CommerceServer.Catalog
Assembly: Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)
Syntax
'Declaration
<ObsoleteAttribute("Category.GetProducts has been replaced by Category.ChildProducts")> _
Public Function GetProducts ( _
searchOptions As CatalogSearchOptions, _
recursive As Boolean _
) As DataSet
'Usage
Dim instance As Category
Dim searchOptions As CatalogSearchOptions
Dim recursive As Boolean
Dim returnValue As DataSet
returnValue = instance.GetProducts(searchOptions, _
recursive)
[ObsoleteAttribute("Category.GetProducts has been replaced by Category.ChildProducts")]
public DataSet GetProducts(
CatalogSearchOptions searchOptions,
bool recursive
)
[ObsoleteAttribute(L"Category.GetProducts has been replaced by Category.ChildProducts")]
public:
DataSet^ GetProducts(
CatalogSearchOptions^ searchOptions,
bool recursive
)
public function GetProducts(
searchOptions : CatalogSearchOptions,
recursive : boolean
) : DataSet
Parameters
- searchOptions
Type: Microsoft.CommerceServer.Catalog..::.CatalogSearchOptions
Specify the filtering options for child categories.
- recursive
Type: System..::.Boolean
A value that indicates whether to include the products recursively.
Return Value
Type: System.Data..::.DataSet
The DataSet contains a single DataTable with the product properties data that match the search criteria.
Remarks
A recursive value of true indicates that the search is recursive; otherwise false.
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.
GetProducts has been replaced by Category.Products
Permissions
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.