Share via

ProductCatalog3.AddSpecificationSearchClause Method (PIA)

  • Article

Use this method to add constraints to a specification search of this catalog.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
…
Public Sub AddSpecificationSearchClause(strClause As String,
 pstrSearchHandle As Object)

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
…
public void AddSpecificationSearchClause(stringstrClause,
 ref object pstrSearchHandle);

Parameters

[Visual Basic .NET]

  • strClause
    A String that contains the clause to be added to the specified specification search.
  • pstrSearchHandle
    An Object that contains the state of the specification search to which the clause will be added. This Object is also used to return the updated state of the specification search.

[C#]

  • strClause
    A string that contains the clause to be added to the specified specification search.
  • pstrSearchHandle
    Set to an object that contains the state of the specification search to which the clause will be added. Returned with the updated state of the specification search.

Exceptions

This method 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 COMException may wrap as exceptions for this method.

Constant Value Description
E_CAT_INVALID_PARAMETER

[C#] 0x889800B6

[Visual Basic .NET] &H889800B6

 The input parameter <parameter number> is invalid.
E_CAT_INVALID_SPECSEARCH_HANDLE

[C#] 0x8898010D

[Visual Basic .NET] &H8898010D

 The search handle that you specified is invalid. The search handle should be of the form [CatalogName][CategoryName] AND (Search Clause1) AND (SearchClause2) ....

Remarks

The specification clause contained in the strClause parameter will be appended to the existing clauses and sent to SQL Server without any changes when the specification search is performed.

[C#]

Upon successful completion, the pstrSearchHandle parameter will contain the name of the updated specification search.

The specification clause contained in the strClause parameter will be appended to the existing clauses and sent to SQL Server without any changes when the specification search is performed.

Example

[Visual Basic .NET]

myProductCatalog.AddSpecificationSearchClause(strClause, pstrSearchHandle)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

ProductCatalog3 Class

ProductCatalog3.BeginSpecificationSearch

ProductCatalog3.GetSpecificationSearchClauses

ProductCatalog3.PerformSpecificationSearch

Copyright © 2005 Microsoft Corporation.
All rights reserved.