GlobalConfig.Sites Method (PIA)

Article
11/12/2009

Use this method to retrieve a list of all the sites available in the Administration database. This method returns an Object that implements the _Recordset interface that contains a single record; the number of fields in the Fields collection is equal to the number of sites in the Microsoft Commerce Server 2002 installation. Each Fields collection contains the name of one of the sites.

Definition (PIA)

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Configuration
Imports ADODB26Lib    ‘ for _Recordset
…
Public Function Sites() As _Recordset

[C#]

using Microsoft.CommerceServer.Interop.Configuration;
using ADODB26Lib;                                   //For _Recordset
…
public _Recordset Sites();

Return Values (PIA)

[Visual Basic .NET] If this method completes successfully, it returns an Object that implements the _Recordset interface that contains a list of all the sites available in the Administration data store.

[C#] This method returns an object that implements the ADODB26Lib._Recordset interface****to a Recordset containing a list of all sites available in the Administration data store.

Exceptions

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

Remarks

The Initialize method must be called before this method can be called.

Requirements

Namespace: Microsoft.CommerceServer.Interop.Configuration

Platforms: Windows 2000, Windows Server 2003

Assembly: cs_mscscfg (in cs_mscscfg.dll)