PurgeStore Method  
 

Purge all deleted messages from the current message store.

Syntax

object.PurgeStore

Parameters

None.

Return Value

A value of zero is returned if the action was successful. Otherwise, a non-zero error code is returned which indicates the cause of the failure.

Remarks

The PurgeStore method purges all deleted messages from the message store. If the storage file has been opened in read-only mode or there are no messages marked for deletion, this method will take no action.

When the CloseStore method is called, the storage file will automatically be purged. To prevent deleted messages from being removed from the message store, use the Reset method.

See Also

StoreFile Property, CloseStore Method, DeleteMessage Method, OpenStore Method, ReadStore Method, WriteStore Method