IListManager::ExportToFile
.gif "Ee825714.c++_off(en-US,CS.10).gif")
.gif "Ee825714.vb_on(en-US,CS.10).gif")
Use this method to export a Mailing list to a text file.
Definition
HRESULT IListManager::ExportToFile(VARIANTlistID,BSTRfileName,BOOLbUnicode,BOOLbOverwrite,BOOL bAsync,VARIANT*pvarOpID);
Parameters
listID
[in] A VARIANT that contains the ID or name of the list to be exported.
fileName
[in] A BSTR that contains the name of the file.
bUnicode
[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.
bOverwrite
[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.
bAsync
[in] A BOOL that specifies whether the creation operation is performed synchronously or asynchronously. A value of True indicates asynchronous processing.
pvarOpID
[out, optional] A pointer to a VARIANT used to return an Operation ID.
Return Values
This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
Error Values
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.
The following table shows the custom COM errors that this method can return.
| Constant | Value | Description |
| E_LM_BAD_FILE_PATH | 0x8C40000A | The specified file path is not valid. |
| E_LM_FILE_ACCESS_DENIED | 0x8C400009 | 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 | 0x8C400010 | The specified file cannot be created because it already exists. |
| E_LM_FILESHARE_NOT_FOUND | 0x8C400016 | The network share does not exist and a full path was not specified for the file. |
| E_LM_LIST_BUSY | 0x8C400008 | The specified list is currently busy with another operation. |
| E_LM_LIST_IN_FAILED_STATE | 0x8C40001D | The specified list is in a FAILED state and may not be used for the operation. |
| E_LM_LIST_NOT_FOUND | 0x8C400006 | The specified list does not exist. |
| E_LM_MAILABLE_REQUIRED | 0x8C400011 | The operation requires a mailable list and the specified list is not a mailable list. |
| E_LM_OPER_CANCELED | 0x8C40000B | The operation was canceled. |
| E_LM_SQLERROR | 0x8C400003 | Error while executing SQL/ADO operation. |
| OLE_E_BLANK | 0x80040007 | The ListManager object has not been properly initialized. |
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.
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.