_GlobalConfig2::MakeSimpleListFromArray Method [C++]

  • Article

Use this method to convert an Array into a SimpleList object.

Definition

[C++]

HRESULT _GlobalConfig2::MakeSimpleListFromArray(VARIANT*varArray,
  IDispatch**iSimpleList);

[Visual Basic]

Function MakeSimpleListFromArray(varArray As Variant) As Object

Parameters

  • varArray[C++]
    [in] A pointer to the VARIANT that contains the Array to convert.
  • varArray[Visual Basic]
    A Variant that contains the Array to convert.
  • iSimpleList[C++]
    [out, retval] The address of an IDispatch pointer used to return the converted SimpleList object.

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 an object reference to the converted SimpleList object.

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 iSimpleList parameter contains valid data only if the method completes successfully.

Ee823825.important(en-US,CS.20).gif Important

  • There is a special group of methods used with multivalued arrays. These methods are the only approved and recommended way of storing and retrieving multivalued arrays in the Administration database. You must use the following methods with any property that has the structure of a multivalued array:
    • MakeArrayFromSimpleList
    • MakeSimpleListFromArray
    • MakeArrayFromString
    • MakeStringFromArray

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

Example

' vMyArray is a Variant
' varMySimpleList is a SimpleList object
' oGlobalConfig2 is a Commerce GlobalConfig2 object
varMySimpleList = oGlobalConfig2.MakeSimpleListFromArray(vMyArray)

See Also

[C++]GlobalConfig2****Object

[Visual Basic]GlobalConfig2****Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.