IListManager::ExportToFile Method [C++]

Article
11/12/2009

Use this method to export a Mailing list to a text file.

Definition

[C++]

HRESULT IListManager::ExportToFile(VARIANTlistID,
 BSTRfileName,
 BOOLbUnicode,
 BOOLbOverwrite,
 BOOL bAsync,
 VARIANT*pvarOpID);

[Visual Basic]

Sub ExportToFile(listID As Variant,
 fileName As String,
 bUnicode As Boolean,
 bOverwrite As Boolean,
 bAsync As Boolean,
 Optional pvarOpID As Variant)

Parameters

listID[C++]
[in] A VARIANT that contains the ID or name of the list to be exported.
listID[Visual Basic]
A Variant that contains the ID or name of the list to be exported.
fileName[C++]
[in] A BSTR that contains the name of the file.
fileName[Visual Basic]
A String that contains the name of the file.
bUnicode[C++]
[in] A BOOL that specifies the character format of the export file. A value of True indicates that Unicode characters should be used. A value of False indicates that the current system codepage character set should be used.
bUnicode[Visual Basic]
A Boolean that specifies the character format of the export file. A value of True indicates that Unicode characters should be used. A value of False indicates that the current system codepage character set should be used.
bOverwrite[C++]
[in] A BOOL that specifies whether to overwrite the data in the export file, if it exists. A value of True indicates that the data should be overwritten. A value of False causes the method to fail if the file exists.
bOverwrite[Visual Basic]
A Boolean that specifies whether to overwrite the data in the export file, if it exists. A value of True indicates that the data should be overwritten. A value of False causes the method to fail if the file exists.
bAsync[C++]
[in] A BOOL that specifies whether the creation operation is performed synchronously or asynchronously. A value of True indicates asynchronous processing.
bAsync[Visual Basic]
A Boolean that specifies whether the creation 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.

[C++]

Return Values

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

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_BAD_FILE_PATH	[C++] 0x8C40000A [Visual Basic] &H8C40000A	The specified file path is not valid.
E_LM_FILE_ACCESS_DENIED	[C++] 0x8C400009 [Visual Basic] &H8C400009	The ListManager service does not have permission to open the specified file.Check the permissions for the ListManager service account against the permissions for the file.
E_LM_FILE_ALREADY_EXISTS	[C++] 0x8C400010 [Visual Basic] &H8C400010	The specified file cannot be created because it already exists.
E_LM_FILESHARE_NOT_FOUND	[C++] 0x8C400016 [Visual Basic] &H8C400016	The network share does not exist and a full path was not specified for the file.
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_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.
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

If the list is a Mailable list but not a Mailing list, a temporary Mailing list is created and then exported.

If an absolute file path and name are not specified, ListManager exports the file relative to a root folder named CommerceLists on the local computer running the ListManager resource. If the folder does not exist, an error is returned.

ListManager exports the file in the following format. The is Message Format field is an integer, all other fields are strings and enclosed in double quotation marks.

   <Mail-to address>,<User ID>,<Message Format>,<Locale>,
   <Source URL><cr><lf>

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

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