Share via

GuaranteedSpecificationSearch Method (String, SpecificationSearchPropertyResult[], CatalogSearchOptions, Int32)

  • Article

NOTE: This API is now obsolete.

(Obsolete) Use the SpecificationSearch class instead with the CatalogContext specification search methods.

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

Syntax

'Declaration
<ObsoleteAttribute("Use the SpecificationSearch class instead the CatalogContext specification search methods.")> _
Public Function GuaranteedSpecificationSearch ( _
    ByRef searchHandle As String, _
    <OutAttribute> ByRef propertyValues As SpecificationSearchPropertyResult(), _
    searchOptions As CatalogSearchOptions, _
    <OutAttribute> ByRef totalRecords As Integer _
) As DataSet

'Usage
Dim instance As ProductCatalog
Dim searchHandle As String
Dim propertyValues As SpecificationSearchPropertyResult()
Dim searchOptions As CatalogSearchOptions
Dim totalRecords As Integer
Dim returnValue As DataSet

returnValue = instance.GuaranteedSpecificationSearch(searchHandle, _
    propertyValues, searchOptions, totalRecords)

[ObsoleteAttribute("Use the SpecificationSearch class instead the CatalogContext specification search methods.")]
public DataSet GuaranteedSpecificationSearch(
    ref string searchHandle,
    out SpecificationSearchPropertyResult[] propertyValues,
    CatalogSearchOptions searchOptions,
    out int totalRecords
)

[ObsoleteAttribute(L"Use the SpecificationSearch class instead the CatalogContext specification search methods.")]
public:
DataSet^ GuaranteedSpecificationSearch(
    String^% searchHandle, 
    [OutAttribute] array<SpecificationSearchPropertyResult^>^% propertyValues, 
    CatalogSearchOptions^ searchOptions, 
    [OutAttribute] int% totalRecords
)

public function GuaranteedSpecificationSearch(
    searchHandle : String, 
    propertyValues : SpecificationSearchPropertyResult[], 
    searchOptions : CatalogSearchOptions, 
    totalRecords : int
) : DataSet

Parameters

  • searchHandle
    Type: System..::.String%
    The specification search handle. May not be nullNothingnullptra null reference (Nothing in Visual Basic).
  • totalRecords
    Type: System..::.Int32%
    The total number of records matching the query.

Return Value

Type: System.Data..::.DataSet
A DataSet with a single DataTable containing the search results.

Remarks

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.

Permissions

See Also

Reference

ProductCatalog Class

ProductCatalog Members

GuaranteedSpecificationSearch Overload

Microsoft.CommerceServer.Catalog Namespace