CatalogContext.GetCatalogs (String, String, CatalogSearchOptions) Method (BCL)

  • Article

Use this method to search for catalogs using a TSQL query, which returns results as specified by the searchOptions parameter.

[Visual Basic .NET]

Overridable Public Function GetCatalogs( _ByValsearchClause As System.String, _
  ByVallanguage As System.String, _
  ByValsearchOptions As CatalogSearchOptions _
) As System.Data.DataSet

[C#]

public virtual System.Data.DataSet GetCatalogs(System.StringsearchClause,
  System.Stringlanguage,
  CatalogSearchOptionssearchOptions);

Parameters

[Visual Basic .NET]

  • searchClause
    The search clause. May not be null.
  • language
    The language, specified as a .NET RFC 1766 culture code. If null, it defaults to the current user interface culture.
  • searchOptions
    The CatalogSearchOptions object. May be null.

[C#]

  • searchClause
    The search clause. May not be null.
  • language
    The language, specified as a .NET RFC 1766 culture code. If null, it defaults to the current user interface culture.
  • searchOptions
    The CatalogSearchOptions object. May be null.

Return Value

A DataSet with a single DataTable containing the properties of catalogs that matched the query.

Remarks

The following properties of the searchOptions parameter are used; any others are ignored:

  • StartingRecord
  • RecordsToRetrieve
  • Language

Throws an ArgumentNullException if the searchOptions parameter is null. Throws a CatalogException on failure.

If the language parameter is not specified, the CultureInfo.CurrentUICulture value is used.

Requirements

Namespace: Microsoft.CommerceServer.Runtime.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: Microsoft.CommerceServer.Runtime.dll

Copyright © 2005 Microsoft Corporation.
All rights reserved.