SiteConfig.MakeStringFromSimpleList Method (PIA)

  • Article

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

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Configuration
…
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.

Return Values

This method returns the 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

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

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

Ee785390.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 arrays, SimpleLists, or objects as Fields columns. Therefore, the SiteConfig object resorts to storing data in an encoded string format.

[Visual Basic .NET]

Example

' vEncoded is a string
' varMySimpleList is a SimpleList object
' oSiteConfigReadOnly is a Commerce SiteConfigReadOnly object
vEncoded = oSiteConfigReadOnly.MakeStringFromSimpleList(varMySimpleList)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Configuration

Platforms: Windows 2000, Windows Server 2003

Assembly: cs_mscscfg (in cs_mscscfg.dll)

See Also

SiteConfig Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.