MimeCloseMessageStore Function  
 
BOOL WINAPI MimeCloseMessageStore(
  HMESSAGESTORE hStorage,  
  BOOL bPurgeMessages  
);

The MimeCloseMessageStore function closes the specified message store.

Parameters

hStorage
Handle to the message store.
bPurgeMessages
An integer value which specifies if deleted messages are purged from the message store. A non-zero value specifies that all messages marked for deletion will be removed from the message store. A value of zero specifies that deleted messages will not be removed from the store.

Return Value

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

Remarks

The MimeCloseMessageStore function closes the storage file that was previously opened, releasing all of the memory allocated for the message store and optionally purging all deleted messages. This function must be called when the application has finished accessing the messages in the message store. Failure to call this function will leave the storage file open and potentially locked by the process.

Requirements

Client: Requires Windows 7, Windows Vista or Windows XP.
Server: Requires Windows Server 2008 or Windows Server 2003.
Header: Include cstools7.h.
Library: Use csmsgav7.lib.

See Also

MimeCopyMessageStore, MimeOpenMessageStore, MimePurgeMessageStore