ListManager.Subtract Method (PIA)

Use this method to subtract one mailing list from another mailing list, and to place the result in a third list.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Targeting
…
Public Sub Subtract(srcList As Object,
 lessList As Object,
 resList As Object,
 errLimit As Integer,
 bAsync As Integer,
 Optional ByRef pvarOpID As Object)

[C#]

using Microsoft.CommerceServer.Interop.Targeting;
…
public void Subtract(objectsrcList,
 objectlessList,
 objectresList,
 interrLimit,
 intbAsync,
 ref objectpvarOpID);

Parameters

[Visual Basic .NET]

  • srcList
    An Object that contains the ID or name of the list from which elements will be subtracted.
  • lessList
    An Object that contains the ID or name of the less list.
  • resList
    An Object that contains the ID or name of the list into which the results of the subtraction operation will be placed.
  • errLimit
    An Integer that is not used.
  • bAsync
    An Integer that specifies whether the copy operation is performed synchronously or asynchronously. A value of 1 indicates asynchronous processing. A value of 0 indicates synchronous processing.
  • pvarOpID
    An optional Object used to return an Operation ID. This Operation ID is used in subsequent processing concerning this operation.

[C#]

  • srcList
    An object that contains the ID or name of the list from which elements will be subtracted.
  • lessList
    An object that contains the ID or name of the less list.
  • resList
    An object that contains the ID or name of the list into which the results of the subtraction operation will be placed.
  • errLimit
    An int that is not used.
  • bAsync
    An int that specifies whether the copy operation is performed synchronously or asynchronously. A value of 1 indicates asynchronous processing. A value of 0 indicates synchronous processing.
  • pvarOpID
    A reference to an object used to return an Operation ID. This Operation ID is used in subsequent processing concerning this operation.

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
&H8C400008 The specified list is currently busy with another operation.
&H8C40001D The specified list is in a FAILED state and may not be used for the operation.
&H8C400006 The specified list does not exist.
&H8C400011 The operation requires a Mailable list and the specified list is not a Mailable list.
&H8C40000B The operation was canceled.
&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
0x8C400008 The specified list is currently busy with another operation.
0x8C40001D The specified list is in a FAILED state and may not be used for the operation.
0x8C400006 The specified list does not exist.
0x8C400011 The operation requires a Mailable list and the specified list is not a Mailable list.
0x8C40000B The operation was canceled.
0x8C400003 Error while executing SQL/ADO operation.
0x80040007 The ListManager object has not been properly initialized.

Remarks

The result list must exist prior to calling the method; however, any data in the list will be overwritten.

This method keys on the rcp_email column, and therefore both the source (srcList parameter) and less (lessList parameter) lists must be Mailable lists (LISTFLAG_MAILABLE set to True). Records from the source list that do not have duplicate e-mail addresses (rcp_email)**in the less list are copied to the result (resList parameter) list. Any existing data in the result list is deleted.

The parameter pvarOpID contains valid data only if the subtraction operation is performed asynchronously.

[Visual Basic .NET]

Example

oListManager.Subtract ("{2B544800-4169-4C49-8713-1B794078B4C9}", _
 "{454799A2-312B-4F5F-90A0-F514FBA0EC5A}", _
 "{7131B794-5448-078B-B544-799A2311B79A}", 10, 0)

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.