_SiteConfigReadOnly::MakeStringFromSimpleList Method [C++]

  • Article

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

Definition

[C++]

HRESULT _SiteConfig::MakeStringFromSimpleList(IDispatch**slist,
  BSTR*strEncodedString);

[Visual Basic]

Function MakeStringFromSimpleList(slist As Object) As String

Parameters

  • slist[C++]
    [in] An IDispatch interface pointer to the SimpleList object that you wish to convert into an encoded string.
  • slist[Visual Basic]
    An object reference to the SimpleList object that you wish to convert into an encoded string.
  • strEncodedString[C++]
    [out, retval] The address of a BSTR used to return the encoded string.

Return Values

[C++] This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

[Visual Basic] None.

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 strEncodedString parameter points to valid data only if the method completes successfully.

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

Ee799738.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, SimpleLists or objects as Fields columns. Therefore, the SiteConfigReadOnly 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 string
' vArray is a Variant
' varMySimpleList is a SimpleList object
' oSiteConfigReadOnly is a Commerce SiteConfigReadOnly object
vEncoded = oSiteConfigReadOnly.MakeStringFromSimpleList(varMySimpleList)

See Also

[C++]SiteConfigReadOnly Object

[Visual Basic]SiteConfigReadOnly Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.