ListManager.GetListProperty Method (PIA)

Use this method to retrieve a property of a list.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Targeting
…
Public Function GetListProperty(listID As Object,
  listPropertyName As String) As Object

[C#]

using Microsoft.CommerceServer.Interop.Targeting;
…
public object GetListProperty(objectlistID,
  stringlistPropertyName);

Parameters

[Visual Basic .NET]

• listID
  An Object that contains the ID or name of the list.
• listPropertyName
  A String that contains the property name (column of the lm_master table).

[C#]

• listID
  An object that contains the ID or name of the list.
• listPropertyName
  A string that contains the property name (column of the lm_master table).

Return Values

[Visual Basic .NET] If this method completes successfully, it returns an Object containing the value of the property.

[C#] This method returns a reference to an object used to return the value of the property.

Exceptions

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

[Visual Basic .NET]

The following table shows the custom COM errors that a COMException can wrap.

[C#]

The following table shows the custom COM errors that a COMException can wrap.

Remarks

For information about the available list properties, see ListManager.GetLists.

[Visual Basic .NET]

Example

' oSource is an Object
oSource = _
 oListManager.GetListProperty("{454799A2-312B-4F5F-90A0-F514FBA0EC5A}", _
 "list_source")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Targeting

Platforms: Windows 2000, Windows Server 2003

Assembly: listmanagerlib (in listmanagerlib.dll)

See Also

ListManager Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.