_GlobalConfig::MakeArrayFromSimpleList Method [C++]

  • Article

Use this method to convert the specified SimpleList object into an Array.

Definition

[C++]

HRESULT _GlobalConfig::MakeArrayFromSimpleList(IDispatch**list,
  VARIANT*vtArray);

[Visual Basic]

Function MakeArrayFromSimpleList(list As Object) As Variant

Parameters

  • list[C++]
    [in] An IDispatch interface pointer to the SimpleList object that you wish to convert into an Array.
  • list[Visual Basic]
    An object reference to the SimpleList that you wish to convert into an Array.
  • vtArray[C++]
    [out, retval] A pointer to a VARIANT containing the converted Array.

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 Array.

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

Ee797196.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

' vMyVariant is a Variant
' varMySimpleList is an object reference to a SimpleList object
' oGlobalConfig is a Commerce GlobalConfig object
vMyVariant = oGlobalConfig.MakeArrayFromSimpleList(varMySimpleList)

See Also

[C++]GlobalConfig****Object

[Visual Basic]GlobalConfig****Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.