_SiteConfigReadOnly::GetIfCollection
.gif "Ee825671.c++_off(en-US,CS.10).gif")
.gif "Ee825671.vb_on(en-US,CS.10).gif")
Use this method to convert values read from the Fields property into the appropriate object such as a SimpleList object or VariantArray.
Definition
HRESULT _SiteConfig::GetIfCollection(VARIANT*strList,VARIANT*retVal);
Parameters
strList
[in] A pointer to the VARIANT that contains the encoded string to be converted.
retVal
[out, retval] A pointer to a VARIANT used to return the converted data in the appropriate data type.
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.
All ADO, SQL, and ODBC errors will also be returned by this method.
Remarks
The retVal parameter points to valid data only if the method completes successfully.
If the encoding in the string contained in the Fields property indicates a SimpleList object, then a SimpleList object is returned. If the encoding indicates a VariantArray, then a VariantArray is returned. If no collection object is indicated, then the method returns the original encoded input string.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.