IAppCfg::Initialize Method [C++]

Article
11/12/2009

Use this method to initialize an AppConfig object.

Definition

[C++]

HRESULT IAppCfg::Initialize(BSTRbstrSiteName);

[Visual Basic]

Sub Initialize(bstrSiteName As String)

Parameters

bstrSiteName[C++]
[in] A BSTR that contains the name of the site with which this AppConfig object should be associated. This name is not case-sensitive.
bstrSiteName[Visual Basic]
A String that contains the name of the site with which this AppConfig object should be associated. This name is not case-sensitive.

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.

Remarks

The AppConfig object must be initialized before any other method on this object can be used. The initialization usually happens only once in Global.asa immediately after the object is created.

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

Example