CatalogSets.GetCatalogSetInfo Method (PIA)

Use this method to return the basic properties for a catalog set.

Definition

[Visual Basic .NET]

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

[C#]

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

Parameters

[Visual Basic .NET]

• CatalogSetID
  A String that contains the catalog set ID, a GUID.

[C#]

• CatalogSetID
  A string that contains the catalog set ID, a GUID.

Return Values

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

[C#] This method returns an ADODB26Lib._Recordset interface to a Recordset object that will contain the basic properties for a 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 a forward-only Recordset object with a single row and the following fields:

Field	Type	Description
CatalogSetID	GUID	None
CatalogSetName	String, maximum of 255 characters	None
CatalogSetDescription	String, maximum of 255 characters	None
bWildCard	Integer	A Boolean that indicates whether this catalog set automatically includes all catalogs, including any new catalogs that might be created in the future. A value of True indicates that this catalog set includes all existing catalogs. A value of False indicates that this catalog set only includes a specific set of catalogs.

[Visual Basic .NET]

Example

rsMyCatalogSetInfo = myCatalogSets.GetCatalogSetInfo(strCatalogSetID)

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.