Share via

CatalogSets.GetCatalogsInCatalogSet Method (PIA)

  • Article

Use this method to return the catalogs that are included in a particular catalog set.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
Imports ADODB26Lib     ‘ for _Recordset
…
Public Function GetCatalogsInCatalogSet(CatalogSetID As String) As _Recordset

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
using ADODB26Lib;                              //For _Recordset
…
public _Recordset GetCatalogsInCatalogSet(stringCatalogSetID);

Parameters

[Visual Basic .NET]

  • CatalogSetID
    A String that contains the catalog set ID.

[C#]

  • CatalogSetID
    A string that contains the catalog set ID.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns the _Recordset interface of a Recordset object that contains the list of catalogs.

[C#] This method returns an ADODB26Lib._Recordset interface to a Recordset object that will contain the catalogs in the catalog set.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

This method returns (indirectly) a Recordset object with a row for each catalog in the catalog set and the following fields:

Field Type Description
CatalogName
From the CatalogSet_Catalogs table.		 String
maximum of 255 characters		 None
CatalogName
From the CatalogGlobal table.		 String
maximum of 128 characters		 None

[Visual Basic .NET]

Example

rsCatalogNames = myCatalogSets.GetCatalogsInCatalogSet(CatalogSetID)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cs_ctlgsets (in cs_ctlgsets.dll)

See Also

CatalogSets Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.