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

Use this method to search for catalogs using a TSQL query, which returns results as specified by the CatalogSearchOptions parameter, and returns the total number of matching catalog records in the totalRecords parameter.

[Visual Basic .NET]

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

[C#]

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

Parameters

[Visual Basic .NET]

• searchClause
  The search clause.
• 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.
• totalRecords
  (out) The total number of records matching the query.

[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 CultureInfo.CurrentUICulture value.
• searchOptions
  The CatalogSearchOptions object. May be null.
• totalRecords
  (out) The total number of records matching the query.

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 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.