MimeGetStoredMessageCount Function  
 
LONG WINAPI MimeGetStoredMessageCount(
  HMESSAGESTORE hStorage,  
  LPLONG lpnMessages  
);

The MimeGetStoredMessageCount function returns the number of messages in the specified message store.

Parameters

hStorage
Handle to the message store.
lpnLastMessage
A pointer to an integer which will contain the message number for the last message in the storage file. If this information is not required, a NULL pointer may be specified.

Return Value

If the function succeeds, the return value is the number of messages in the message store. If the function fails, the return value is MIME_ERROR. To get extended error information, call MimeGetLastError.

Remarks

The MimeGetStoredMessageCount function returns the number of messages in the message store. It is important to note that does not count those messages which have been marked for deletion. This means that the value returned by this function will decrease as messages are deleted.

The message number returned in the lpnLastMessage parameter will specify the total number of messages in the message store, including deleted messages.

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.
Unicode: Implemented as Unicode and ANSI versions.

See Also

MimeFindStoredMessage, MimeGetStoredMessage, MimeDeleteStoredMessage