IAdminSite::get_Status, put_Status
.gif "Ee810057.c++_off(en-US,CS.10).gif")
.gif "Ee810057.vb_on(en-US,CS.10).gif")
The Status property is a read/write Boolean that indicates whether or not the Site Server 3.0 Commerce Edition site is open or closed. In addition, the Status property either opens or closes the Site Server 3.0 Commerce Edition site, when the value is set.
Definition
Get method:
HRESULT IAdminSite::get_Status(VARIANT_BOOL*Status);
Put method:
HRESULT IAdminSite::put_Status(VARIANT_BOOLStatus);
Parameters
Status
[in] When putting the property, a VARIANT_BOOL that contains the open/closed status of the site.
[out] When getting the property, the address of a VARIANT_BOOL used to return the open/closed status of the site. A value of True indicates that the site is open. A value of False indicates that the site is closed.
Return Values
These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.
Error Values
This property 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
Changing this property sets a value in the site configuration to the text "Open" or "Closed." When the site is reloaded, this value is read by the Global.asa file into the com_compref_frnc.htm value of the site Dictionary object. Each page in the Site Server 3.0 Commerce Edition site then determines whether or not to redirect the browser by checking the value of the Site.Status property. If the text does not equal "Open," then the browser is redirected to the address specified by the Site.CloseRedirectURL property.
When getting the property, the Status parameter contains valid data only if the property is accessed successfully.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.