IMSCSPage_3_0::SiteRoot
.gif "Ee797607.c++_off(en-US,CS.10).gif")
.gif "Ee797607.vb_on(en-US,CS.10).gif")
Use this method to return the physical directory that contains the Commerce Server site.
.gif "Ee797607.important(en-US,CS.10).gif")
Important
- This method is included for backwards compatibility with Site Server 3.0 Commerce Edition.
Definition
HRESULT IMSCSPage_3_0::SiteRoot(BSTR*pbstrRet);
Parameters
pbstrRet
[out, retval] A pointer to a BSTR used to return the physical directory path.
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 pvtRet parameter points to valid data only if the method completed successfully.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.