Previous in Contents Next in Contents

The AdminSite Object

The AdminSite object provides centralized access to the Commerce Server site configuration, making it easier to configure and maintain a Commerce Server site. The AdminSite object is used by the Site Builder Wizard (which sets the configuration initially), Web-based Administration (WebAdmin), the Commerce Host Administration snap-in for the Microsoft® Management Console (MMC), and by batch files. The object provides read/write access to the configuration properties and has a number of administrative functions that allow administration of Commerce Server sites.

The AdminSite object supports the following properties.

Property Description
Directory Currently registered Commerce Server site physical directory.
Status Read/write property that indicates/specifies whether the Commerce Server site is open or closed.
Version Returns the version of Commerce Server as an integer (2 for Commerce Server 2.0, and 3 for Commerce Server 3.0).

The AdminSite object supports the following methods.

Method Description
Create Creates a Commerce Server site.
Delete Deletes a Commerce Server site.
Initialize Initializes the AdminSite object to load information related to the Commerce Server site.
InitializeFromMDPath Initializes the AdminSite object from a metabase path.
IsValidName Determines whether a given text string is a valid short name for a Commerce Server site.
ReadDefaultProperties Reads the properties from the Site.csc file and returns a Dictionary object (the site dictionary) containing these properties.
ReadManagerProperties Reads the properties from the Site\Manager\Config\Site.csc file and returns a Dictionary object (the site dictionary) containing these properties.
Reload Resets all application and session objects for the Commerce Server site.
WriteDefaultProperties Writes the properties from the specified site dictionary to the Site.csc file.
WriteManagerProperties Writes the properties from the specified site dictionary to the Site\Manager\Config\Site.csc file.


© 1997-2000 Microsoft Corporation. All rights reserved.