MsgClose

Syntax

MsgClose(travhandl);

travhandl

The handle used to identify this specific traversing pass. The handle is specified using the MsgOpen, MsgFrameOpen, or MsgFrameOpen function.

Description

Closes the Message after it has been traversed.

When the Message, or the specific context, has been traversed, the Message is closed. For example, if the context is a frame, the Message is closed when the frame has been traversed. The MsgClose function can be used, for example, to avoid unnecessarily allocating of memory if you need to restart a traversing process.

Returns

The Message was successfully closed.

Example

MsgClose($handle);