_GlobalConfig2::GetIfCollection Method [C++]

Use this method to convert values read from the Fields property into appropriate objects such as a SimpleList object or a VariantArray. 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.

Definition

[C++]

HRESULT _GlobalConfig2::GetIfCollection(VARIANT*strList,
  VARIANT*retVal);

[Visual Basic]

Function GetIfCollection(strList As Variant) As Variant

Parameters

• strList[C++]
  [in] A pointer to the VARIANT that contains the encoded string to be converted.
• strList[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 Values

[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, and ODBC errors will also be returned by this method.

Remarks

[C++] The retVal parameter contains 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.

[Visual Basic]

Example

' vVariant is a Variant; vEncodedString is a Variant
' oGlobalConfig2 is a Commerce GlobalConfig2 object
vVariant = oGlobalConfig2.GetIfCollection(vEncodedString)

See Also

[C++]GlobalConfig2****Object

[Visual Basic]GlobalConfig2****Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.