_SiteConfig::Initialize Method [C++]

Article
11/12/2009

Use this method to load the site configuration from the Administration database.

Definition

[C++]

HRESULT _SiteConfig::Initialize(BSTRbstrSiteName);

[Visual Basic]

Sub Initialize(bstrSiteName As String)

Parameters

bstrSiteName[C++]
[in] A BSTR that contains the site name.
bstrSiteName[Visual Basic]
A String that contains the site name.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] None.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

All ADO, SQL, and ODBC errors will also be returned by this method.

Remarks

If the caller is not a member of the COM+ Administrator role, but is in the Web Users role, then a reduced recordset is populated by the Initialize method. This reduced recordset contains only information on the MSCS_Address resources, also known as IIS applications. The SaveConfig function will only save this reduced recordset data.

[Visual Basic]

Example

' sMySiteName is a string
' oSiteConfig is a Commerce SiteConfig object
oSiteConfig.Initialize(sMySiteName)

Share via