SiteConfig.MakeStringFromArray

Use this method to convert an Array object into an encoded string that can be written to the Fields property.

Definition

Function MakeStringFromArray(varArray As Variant) As Variant

Parameters

varArray

A Variant that contains the Array to encode.

Return Values

If this method completes successfully, it returns Variant that contains the encoded string.

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

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

Note

• This method can only be used when updating values exposed by the Fields object. The client-side disconnected ADO recordset has no support for Variants, Arrays, or objects as Fields columns. Therefore, the SiteConfig object resorts to storing data in an encoded string format.

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

Example

' vEncoded is a Variant
' vArray is a Variant
' oSiteConfig is a Commerce SiteConfig object
vEncoded = oSiteConfig.MakeStringFromArray(vArray)

See Also

SiteConfig Object

All rights reserved.