_GlobalConfig::Sites Method [C++]

Article
11/12/2009

Use this method to retrieve a list of all the sites available in the Administration database.

Definition

[C++]

HRESULT _GlobalConfig::Sites (
_Recordset** rsRecordSet);

[Visual Basic]

Function Sites (
) As Object

Parameters

rsRecordSet [C++]

[out, retval] The address of a pointer to a _Recordset object used to return the list of all sites available in the Administration database. Each Field object in the recordset includes the name of one of the sites in the Commerce Server 2002 installation.

[Visual Basic] None.

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 Recordset object. Each Field object in the recordset includes the name of one of the sites in the Commerce Server 2002 installation.

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 rsRecordSet parameter contains valid data only if the method completes successfully.

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