_GlobalConfig2::CreateSiteConfig Method [C++]

Article
11/12/2009

Use this method to create a site using the name specified in the bstrSiteName parameter. This method calls the SaveConfig method. This method is used primarily from Commerce Server Manager or by Commerce Server Site Packager.

Definition

[C++]

HRESULT _GlobalConfig2::CreateSiteConfig(BSTRbstrSiteName,
  IMSCSSiteConfigAdmin**ppsca);

[Visual Basic]

Function CreateSiteConfig(bstrSiteName As String) As Object

Parameters

bstrSiteName[C++]
[in] A BSTR that contains the new site name.
bstrSiteName[Visual Basic]
A String that contains the new site name.
ppsca[C++]
[out] The address of a pointer to the SiteConfig object used to return the site configuration settings.

Return Values

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

[Visual Basic] If this method completes successfully, it returns a SiteConfig object that contains the site configuration settings.

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

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

[C++] The ppsca parameter contains valid data only if the method returns successfully.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.