set_message_paramT_set_message_paramSetMessageParamSetMessageParamset_message_param (算子名称)

名称

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

参数签名

描述

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

For each call of set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParamset_message_param, 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 KeyKeyKeyKeykeykey 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 KeyKeyKeyKeykeykey. The keys are processed in the same order as specified in the KeyKeyKeyKeykeykey parameter.

Key-independent parameter names:

'remove_all_keys'"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 GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value is ignored for this parameter, while KeyKeyKeyKeykeykey must be an empty tuple.

Key-specific parameter names:

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

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

运行信息

• 多线程类型:可重入(与非独占操作符并行运行)。
• 多线程作用域:全局(可以从任何线程调用)。
• 未经并行化处理。

This operator modifies the state of the following input parameter:

• MessageHandleMessageHandleMessageHandleMessageHandlemessageHandlemessage_handle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

参数表

例程 (HDevelop)

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

结果

If all 该算子 parameters, and their values, as well as specified keys are valid, set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParamset_message_param returns 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

可能的前置算子

dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessagedequeue_message, create_messagecreate_messageCreateMessageCreateMessageCreateMessagecreate_message

可能的后置算子

enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessageenqueue_message, clear_messageclear_messageClearMessageClearMessageClearMessageclear_message

参考其它

create_messagecreate_messageCreateMessageCreateMessageCreateMessagecreate_message, clear_messageclear_messageClearMessageClearMessageClearMessageclear_message, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTupleset_message_tuple, get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTupleget_message_tuple, set_message_objset_message_objSetMessageObjSetMessageObjSetMessageObjset_message_obj, get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObjget_message_obj, get_message_paramget_message_paramGetMessageParamGetMessageParamGetMessageParamget_message_param, enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessageenqueue_message, dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessagedequeue_message

模块

Foundation

---