IMSCSPage_3_0::Check
Use this method to generate the word CHECKED into a page if the value specified in the vtCheck parameter is a nonzero value. CHECKED is a parameter to an HTML <INPUT> tag, which sets a check box or radio button to selected when the form first loads.
Important
- This method is included for backwards compatibility with Site Server 3.0 Commerce Edition.
Definition
HRESULT IMSCSPage_3_0::Check(VARIANTvtCheck,BSTR*pbstrRet);
Parameters
vtCheck
[in] A VARIANT that contains the expression that is evaluated to determine whether the word CHECKED should be inserted at the location on a page where the call to Check appears.
pbstrRet
[out, retval] A pointer to a BSTR used to return the string "CHECKED" or "".
Return Values
This method returns an HRESULT indicating whether 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 pbstrRet parameter points to 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.