GlobalConfig2.MakeStringFromSimpleList Method (PIA)

  • Article

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

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Configuration
…
Public Function MakeStringFromSimpleList(ByRefslist As Object) As String

[C#]

using Microsoft.CommerceServer.Interop.Configuration;
…
public string MakeStringFromSimpleList(ref objectslist);

Parameters

[Visual Basic .NET]

  • slist
    An object reference to the SimpleList object that you want to convert into an encoded string.

[C#]

  • slist
    A SimpleList object that you want to convert into an encoded string.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

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

Ee796738.important(en-US,CS.20).gif****Important

  • There is a special group of methods used with multi-valued arrays. These methods are the only approved and recommended way of storing and retrieving multi-valued arrays in the Administration database. You must use the following methods with any property that has the structure of a multi-valued array:
    • MakeArrayFromSimpleList
    • MakeSimpleListFromArray
    • MakeArrayFromString
    • MakeStringFromArray

Ee796738.note(en-US,CS.20).gif Note

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

[Visual Basic .NET]

Example

' vEncoded is a string
' varMySimpleList is an object reference to a SimpleList object
' oGlobalConfig is a Commerce GlobalConfig2 object
vEncoded = oGlobalConfig.MakeStringFromSimpleList(varMySimpleList)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Configuration

Platforms: Windows 2000, Windows Server 2003

Assembly: CS_MSCSCfg (in cs_mscscfg.dll)

See Also

GlobalConfig2 Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.