TransportFreeMsg

The TransportFreeMsg function destroys the MailMsg heap allocated by TransportRecv and resets the heap, header, and message body pointers to NULL.

Syntax

BOOL TransportFreeMessage(MailMsg * MsgPtr);

At a Glance

Header file: Smtp.h
Platforms: H/PC
Windows CE versions: 1.0 and later

Parameters

hService
Handle to a SERVICE structure.

Return Values

Returns TRUE if successful. Returns FALSE if MsgPtr is invalid or if the hHeap member of the specified MailMsg structure does not exist.

Remarks

The TransportFreeMsg function must be implemented by the transport service provider in a DLL registered as a mail service. The Inbox application can load this DLL and call this function.

See Also

TransportRecv