MailFree

The MailFree function returns storage space back to the system from a previous MailFirst, MailGet, or MailNext function call.

Syntax

BOOL MailFree (MailMsg* pmm);

At a Glance

Header file:	Msgstore.h
Platforms:	H/PC
Versions:	1.0 and later

Parameters

pmm: Pointer to the MailMsg structure being freed.

Return Values

This function returns TRUE if successful; FALSE if it fails. To get extended error information, use MailError or MailErrorMsg.

Remarks

The message flags set (in the dwFlags field of MailMsg) before a call to retrieve a message from the message store determine whether the MailFree function needs to allocate memory.