_GlobalConfig2::MakeStringFromArray Method [C++]

  • Article

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

Definition

[C++]

HRESULT _GlobalConfig2::MakeStringFromArray(VARIANT*varArray,
  VARIANT*vtEncodedString);

[Visual Basic]

Function MakeStringFromArray(varArray As Variant) As Variant

Parameters

  • varArray[C++]
    [in] A pointer to the VARIANT that contains the Array to encode.
  • varArray[Visual Basic]
    A Variant that contains the Array to encode.
  • vtEncodedString[C++]
    [out, retval] A pointer to a VARIANT used to return the encoded string.

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 Variant that contains the encoded string.

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

The Initialize method must be called before this method can be called.

[C++] The vtEncodedString parameter contains valid data only if the method completes successfully.

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

Ee810539.note(en-US,CS.20).gif 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 GlobalConfig2 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.

[Visual Basic]

Example

' vEncoded is a Variant
' vArray is a Variant
' oGlobalConfig2 is a Commerce GlobalConfig2 object
vEncoded = oGlobalConfig2.MakeStringFromArray(vArray)

See Also

[C++]GlobalConfig2****Object

[Visual Basic]GlobalConfig2****Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.