CMessageStore::CopyFile Method  
 
BOOL CopyFile(
  LPCTSTR lpszFileName  
);

The CopyFile method duplicates the contents of the current message store in a new file.

Parameters

lpszFileName
A pointer to a string which specifies the name of the file that the messages will be copied to. This parameter cannot be NULL and must specify a valid file path and name.

Return Value

If the method succeeds, the return value is non-zero. If the method fails, the return value is zero. To get extended error information, call MimeGetLastError.

Remarks

The CopyFile method is used to create a copy of the current message store in a new file. If the file does not exist, it will be created. If the file already exists, then the contents will be overwritten with the contents of the message store.

Messages that have been marked for deletion are not copied to the new message store file.

Requirements

Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csmsgv10.lib
Unicode: Implemented as Unicode and ANSI versions.

See Also

CloseFile, OpenFile, PurgeFile