_SiteConfig::GetIfCollection Method
Note
This object is obsolete. Use SiteConfigFreeThreaded instead.
Use this method to convert values read from the Fields property into the appropriate object such as a SimpleList object or variant array.
HRESULT _SiteConfig::GetIfCollection(
VARIANT* strList,
VARIANT* retVal
);
Function GetIfCollection(
strList As Variant
) As Variant
Parameters
strList
[C++][in] A pointer to the VARIANT that contains the encoded string to be converted.
[Visual Basic]
A Variant that contains the encoded string to be converted.
retVal
[C++][out, retval] A pointer to a VARIANT used to return the converted data in the appropriate data type.
Return Value
[C++]
This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
[Visual Basic]
If this method completes successfully, it returns a variant containing the converted data in the appropriate data type.
Error Values
[C++]
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.
[Visual Basic]
This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM 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. In particular, the Description property may contain a text description of the error.
All ADO, SQL Server, 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 variant array, then a variant array is returned. If no collection object is indicated, then the method returns the original encoded input string.
Example
' vVariant is a Variant; vEncodedString is a Variant.
' oSiteConfig is a SiteConfig object.
vVariant = oSiteConfig.GetIfCollection(vEncodedString)