AdminSite Object
Use this object to gain centralized access to the Site Server 3.0 Commerce Edition site configuration, so that you can configure and maintain the site.
Important
- You cannot use this object with Commerce Server 2000 sites. It is included only for backwards compatibility with Site Server 3.0 Commerce Edition.
ProgID: | Commerce.AdminSite (Externally creatable) |
COM Class Name: | AdminSite |
Type Library Name: | Commerce Admin 1.0 Type Library |
DLL Name: | MSCSadmin.dll |
Threading Model: | Both |
The properties of the AdminSite object are shown in the following table.
Property | Type | Description |
Directory | String | Stores the currently registered Site Server 3.0 Commerce Edition site physical directory.
This property is read/write. |
Status | Variant | Stores the open/closed status of a Site Server 3.0 Commerce Edition site.
This property is read/write. |
Version | Long | Stores the Site Server 3.0 Commerce Edition version number.
This property is read-only. |
The methods of the AdminSite object are shown in the following table.
Method | Description |
Create | Creates a Site Server 3.0 Commerce Edition site. |
Delete | Deletes a Site Server 3.0 Commerce Edition site. |
Initialize | Initializes the AdminSite object to load information related to the Site Server 3.0 Commerce Edition site. |
InitializeFromMDPath | Initializes the AdminSite object from a metabase path. |
IsValidName | Determines whether a given text string is a valid short name for a Site Server 3.0 Commerce Edition site. |
ReadDefaultProperties | Reads the properties from the Site.csc file and returns a Dictionary object 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 Site Server 3.0 Commerce Edition 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. |
Remarks
The AdminSite object provides methods for administering a site, such as specifying data sources and user accounts. The object keeps a number of properties related to the configuration in the site dictionary, which is an implementation of a Dictionary object called MSCSSite. These properties include the short and long names of the site, the secure host, the non-secure host, and the names of other Dictionary objects such as lists of named connection strings and named queries.