CMailMessage::AttachHandle Method  
 
VOID AttachHandle(
  HMESSAGE hMessage  
);

The AttachHandle method attaches the specified message handle to the current instance of the class.

Parameters

hMessage
The handle to the message that will be attached to the current instance of the class object.

Return Value

None.

Remarks

This method is used to attach a message handle created outside of the class using the SocketTools API. Once the handle is attached to the class, the other class member functions may be used with that message.

If a message handle already has been created for the class, that handle will be released when the new handle is attached to the class object. If you want to prevent the previous message from being destroyed, you must call the DetachHandle method. Failure to release the detached handle may result in a resource leak in your application.

Note that the hMessage parameter is presumed to be a valid message handle and no checks are performed to ensure that the handle is valid. Specifying an invalid message handle will cause subsequent method calls to fail.

Requirements

Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csmsgv10.lib

See Also

DetachHandle, GetHandle