FreeMessage (FUN)

FUNCTION FreeMessage : ERROR

This function releases a message that has been created with CreateMessage, read with Read or duplicated with CloneMessage.

Note

Do not free a message after it has been passed to the CL2 layer.
Example: Creating a message, then passing the message handle to CL2 by calling Write and releasing it afterwards may result in unexpected behaviour.
InOut:

Scope

Name

Type

Comment

Return

FreeMessage

ERROR

ERROR.NO_ERROR or appropriate error code

Input

hMessage

CAA.HANDLE

handle of message to be freed