clear_message — Close a message handle and release all associated resources.
clear_message( : : MessageHandle : )
clear_message closes a message handle MessageHandle that was previously opened with create_message or dequeue_message. Any resources owned by the message, in particular the tuple or object data stored in the message, will be released.
Multiple message handles can be closed in a single clear_message call, passing them as a tuple to the MessageHandle parameter.
The handle(s) must not be used again after being invalidated using clear_message. Using an invalid handle results in undefined behavior.
Message handle(s) to be closed.
Number of elements: MessageHandle >= 1
Restriction: MessageHandle != 0
MessageHandles :=  for idx := 0 to 4 by 1 create_message (MessageHandle) MessageHandles[idx]:= MessageHandle endfor * ... clear_message (MessageHandles)
If the message handle(s) passed to the operator are valid, clear_message returns 2 (H_MSG_TRUE). Otherwise an exception is raised. If a tuple of handles is passed and some of them are invalid, clear_message attempts to clear as many handles from the tuple as possible before reporting the error.
create_message, set_message_tuple, get_message_tuple, set_message_obj, get_message_obj, set_message_param, get_message_param, enqueue_message, dequeue_message