ListManager.GetListFlags Method (PIA)

  • Article

Use this method to retrieve the flags attribute for a list.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Targeting
…
Public Function GetListFlags(listID As Object) As Integer

[C#]

using Microsoft.CommerceServer.Interop.Targeting;
…
public int GetListFlags(objectlistID);

Parameters

[Visual Basic .NET]

  • listID
    An Object that contains the ID or name of the list.

[C#]

  • listID
    An object that contains the ID or name of the list.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns an Integer that contains the flags attribute.

[C#] This method returns an int used to return the flags attribute.

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.

Value Description
&H8C400006 The specified list does not exist.
&H8C400003 Error while executing SQL/ADO operation.
&H80040007 The ListManager object has not been properly initialized.

[C#]

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

Value Description
0x8C400006 The specified list does not exist.
0x8C400003 Error while executing SQL/ADO operation.
0x80040007 The ListManager object has not been properly initialized.

Remarks

The following table lists the possible flag parameter values used to determine the type of list created. Values may be ORed together to specify more than one flag.

Type Value Description
DEFAULT 0x0 A Mailing list
HIDDEN 0x1 The list should not be exposed in the user interface.
DYNAMIC 0x2 A dynamic list
USER 0x4 A User list (contains an rcp_guid column)
GENERIC 0x8 A Generic list
MAILABLE 0x10 A Mailable list (contains an rcp_email column)

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.