clear_messageclear_messageClearMessageClearMessage (Operator)

Name

clear_messageclear_messageClearMessageClearMessage — Close a message handle and release all associated resources.

Signature

Description

clear_messageclear_messageClearMessageClearMessageClearMessage closes a message handle MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle that was previously opened with create_messagecreate_messageCreateMessageCreateMessageCreateMessage or dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage. 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_messageclear_messageClearMessageClearMessageClearMessage call, passing them as a tuple to the MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle parameter.

Attention

The handle(s) must not be used again after being invalidated using clear_messageclear_messageClearMessageClearMessageClearMessage. Using an invalid handle results in undefined behavior.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Example (HDevelop)

MessageHandles := []
for idx := 0 to 4 by 1
  create_message (MessageHandle)
  MessageHandles[idx]:= MessageHandle
endfor
* ...
clear_message (MessageHandles)

Result

If the message handle(s) passed to the operator are valid, clear_messageclear_messageClearMessageClearMessageClearMessage returns 2 (H_MSG_TRUE). Otherwise an exception is raised. If a tuple of handles is passed and some of them are invalid, clear_messageclear_messageClearMessageClearMessageClearMessage attempts to clear as many handles from the tuple as possible before reporting the error.

Possible Predecessors

create_messagecreate_messageCreateMessageCreateMessageCreateMessage, dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage

See also

create_messagecreate_messageCreateMessageCreateMessageCreateMessage, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTuple, get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTuple, set_message_objset_message_objSetMessageObjSetMessageObjSetMessageObj, get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObj, set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParam, get_message_paramget_message_paramGetMessageParamGetMessageParamGetMessageParam, enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessage, dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage

Module

Foundation