ProductCatalog.GuaranteedSpecificationSearch (String, SpecificationSearchPropertyResult[], CatalogSearchOptions, Int32) Method (BCL)

Article
11/12/2009

Use this method to perform a specification search guaranteed to return results if any products exist in the category being searched. The updated property values are returned through the propertyValues parameter. The searchOptions parameter can be used to determine which class of catalog objects to return, the list of properties to return, and the number of records wanted. The total number of matching records is returned through the totalRecords parameter.

Definition

[Visual Basic .NET]

Overridable Public Function GuaranteedSpecificationSearch( _ByValsearchHandle As System.String, _
  ByRefpropertyValues As Microsoft.CommerceServer.Runtime.Catalog.SpecificationSearchPropertyResult[], _
  ByValsearchOptions As CatalogSearchOptions, _
  ByReftotalRecords As System.Int32 _
) As System.Data.DataSet

[C#]

public virtual System.Data.DataSet GuaranteedSpecificationSearch(System.StringsearchHandle,
  out Microsoft.CommerceServer.Runtime.Catalog.SpecificationSearchPropertyResult[]propertyValues,
  CatalogSearchOptionssearchOptions,
  out System.Int32totalRecords);

Parameters

[Visual Basic .NET]

searchHandle
The search handle, updated on output. May not be null.
propertyValues
An array of SpecificationSearchPropertyResult objects.
searchOptions
The CatalogSearchOptions objectspecifying how results should be returned. May be null.
totalRecords
The total number of matching records.

[C#]

searchHandle
The search handle, updated on output. May not be null.
propertyValues
An array of SpecificationSearchPropertyResult objects.
searchOptions
The CatalogSearchOptions object specifying how results should be returned. May be null.
totalRecords
The total number of matching records.

Return Value

A DataSet with a single DataTable containing the search results.

Remarks

The GuaranteedSpecificationSearch method removes search clauses from the handle one at a time until some results are returned.

Throws a CatalogException on failure.

Throws an ArgumentNullException if the catalogContext parameter is null.

Requirements

Namespace: Microsoft.CommerceServer.Runtime.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: Microsoft.CommerceServer.Runtime.dll

Share via