set_message_paramT_set_message_paramSetMessageParamSetMessageParam (Operator)

Name

set_message_paramT_set_message_paramSetMessageParamSetMessageParam — Set message parameter or invoke commands on the message.

Signature

Description

set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParam sets message parameters or invokes action commands on the message.

For each call of set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParam, only a single parameter can be set. However, there are two types of parameters/commands:

• Parameters/commands applicable to the entire message. In this case no keys must be specified, i.e., the parameter KeyKeyKeyKeykey must be an empty tuple.

• Parameters/commands applicable to the individual keys. In this case a non-empty list of keys must be specified in parameter KeyKeyKeyKeykey. The keys are processed in the same order as specified in the KeyKeyKeyKeykey parameter.

Key-independent parameter names:

'remove_all_keys'"remove_all_keys""remove_all_keys""remove_all_keys""remove_all_keys":

Removes all the keys currently stored in the message and releases all the (control or iconic) data associated with those keys. The operation results in an empty message. Note that contents of GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue is ignored for this parameter, while KeyKeyKeyKeykey must be an empty tuple.

Key-specific parameter names:

'remove_key'"remove_key""remove_key""remove_key""remove_key":

Removes the keys specified in the KeyKeyKeyKeykey parameter and releases all the (tuple or object) data associated with those keys. If an error occures while processing one or more keys (in particular if the key is invalid), the operator attempts to continue removing as many keys as possible before reporting the failure. Note that the contents of GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue is ignored for this parameter.

Execution Information

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

This operator modifies the state of the following input parameter:

• MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle

Parameters

Example (HDevelop)

* Remove some keys
set_message_param (Message, 'remove_key', ['my_image', 'simple_string'], [])

Result

If all the operator parameters, and their values, as well as specified keys are valid, set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParam returns 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors

dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage, create_messagecreate_messageCreateMessageCreateMessageCreateMessage

Possible Successors

enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessage, clear_messageclear_messageClearMessageClearMessageClearMessage

See also

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

Module

Foundation