IAdminWebServer::GetCommerceSites

Ee785324.c++_off(en-US,CS.10).gifEe785324.vb_on(en-US,CS.10).gif

Use this method to enumerate all Commerce Server sites associated with the specified Web site. The method returns an array of numbers that represents all Commerce Server site instances.

This method does not work with Commerce Server 2000 sites. It is included only for backward compatibility with Site Server 3.0 Commerce Edition sites.

Definition

HRESULT IAdminWebServer::GetCommerceSites(BSTRbstrInstance,VARIANT*pVarRet);

Parameters

bstrInstance

[in] A numeric value, expressed as a BSTR, that represents a server instance for a site.

pVarRet

[out] The address of a VARIANT used to return an array of numbers that represent all Commerce Server site instances.

Return Values

This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

Error Values

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.

Remarks

The pVarRet parameter contains valid data only if the method returns successfully.

The GetCommerceSites method determines whether a site is a Commerce Server site by examining a reserved key in the metabase.

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

See Also

AdminWebServer Object


All rights reserved.