SiteConfig.MakeSimpleListFromArray

  • Article

Ee784562.c++_on(en-US,CS.10).gifEe784562.vb_off(en-US,CS.10).gif

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

Definition

Function MakeSimpleListFromArray(varArray As Variant) As Object

Parameters

varArray

A Variant that contains the SimpleList object to convert.

Return Values

If this method completes successfully, it returns an object reference to the converted SimpleList object.

Error Values

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

Ee784562.important(en-US,CS.10).gif Important

  • A special group of methods is 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.

Example

' vMyArray is a Variant
' varMySimpleList is a SimpleList object
' oSiteConfig is a Commerce SiteConfig object
varMySimpleList = oSiteConfig.MakeSimpleListFromArray(vMyArray)

See Also

SiteConfig Object


All rights reserved.