IListManager::ExtractMailingList Method [C++]

Article
11/12/2009

Use this method to create a new mailing list from a generic list.

Definition

[C++]

HRESULT IListManager::ExtractMailingList(VARIANTsrcList,
  BSTRreslistName,
  BSTRreslistDesc,
  longuserFlags,
  BOOL bAsync,
  VARIANT*pvarOpID,
  VARIANT*pvarID);

[Visual Basic]

Function ExtractMailingList(srcList As Variant,
  reslistName As String,
  reslistDesc As String,
  userFlags As Long,
  bAsync As Boolean,
  Optional pvarOpID As Variant) As Variant

Parameters

srcList[C++]
[in] A VARIANT that contains the ID or name of the generic source list.
srcList[Visual Basic]
A Variant that contains the ID or name of the generic source list.
reslistName[C++]
[in] A BSTR that contains the new mailing list name.
reslistName[Visual Basic]
A String that contains the new mailing list name.
reslistDesc[C++]
[in] A BSTR that contains the description of the new mailing list.
reslistDesc[Visual Basic]
A String that contains the description of the new mailing list.
userFlags[C++]
[in] A long that contains application specific user flags. Not used by the ListManager object.
userFlags[Visual Basic]
A Long that contains application specific user flags. Not used by the ListManager object.
bAsync[C++]
[in] A BOOL that specifies whether the export operation is performed synchronously or asynchronously. A value of True indicates asynchronous processing.
bAsync[Visual Basic]
A Boolean that specifies whether the export operation is performed synchronously or asynchronously. A value of True indicates asynchronous processing.
pvarOpID[C++]
[out, optional] A pointer to a VARIANT used to return an Operation ID.
pvarOpID[Visual Basic]
An optional Variant used to return an Operation ID.
pvarID[C++]
[out, retval] A pointer to a VARIANT used to return the ID of the new list.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a Variant that contains the ID of the new list.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

The following table shows the custom COM errors that this method can return.

Constant	Value	Description
E_LM_LIST_ALREADY_EXISTS	[C++] 0x8C400007 [Visual Basic] &H8C400007	The specified list has already been created.
E_LM_LIST_BUSY	[C++] 0x8C400008 [Visual Basic] &H8C400008	The specified list is currently busy with another operation.
E_LM_LIST_IN_FAILED_STATE	[C++] 0x8C40001D [Visual Basic] &H8C40001D	The specified list is in a FAILED state and may not be used for the operation.
E_LM_LIST_NOT_FOUND	[C++] 0x8C400006 [Visual Basic] &H8C400006	The specified list does not exist.
E_LM_MAILABLE_LIST_NO_EMAILS	[C++] 0x8C40000D [Visual Basic] &H8C40000D	The list is designated as a Mailable list but does not contain an rcp_email column.
E_LM_MAILABLE_REQUIRED	[C++] 0x8C400011 [Visual Basic] &H8C400011	The operation requires a mailable list and the specified list is not a mailable list.
E_LM_OPER_CANCELED	[C++] 0x8C40000B [Visual Basic] &H8C40000B	The operation was canceled.
E_LM_SQLERROR	[C++] 0x8C400003 [Visual Basic] &H8C400003	Error while executing SQL/ADO operation.
E_LM_USER_LIST_NO_GUIDS	[C++] 0x8C40000E [Visual Basic] &H8C40000E	The list is designated as a User list but does not contain an rcp_guid column.
OLE_E_BLANK	[C++] 0x80040007 [Visual Basic] &H80040007	The ListManager object has not been properly initialized.

[C++] Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

The source list must be a Mailable list (contains an rcp_email column). Any duplicate e-mail addresses are removed in the result list.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

Example

' vListID & pvarOpId are Variants
vListID = oListManager.ExtractMailingList("{454799A2-312B-4F5F-90A0-" & _
 "F514FBA0EC5A}", "TequilaBuyers1", "Tequilla buyers in January", 0, _
 True, pvarOpID)

Share via