set_message_tupleT_set_message_tupleSetMessageTupleSetMessageTupleset_message_tuple (算子名称)

名称

set_message_tupleT_set_message_tupleSetMessageTupleSetMessageTupleset_message_tuple — Add a key/tuple pair to the message.

参数签名

描述

set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTupleset_message_tuple stores a tuple associated with a key in the message, which behaves as a dictionary-like data container. The message is denoted by the MessageHandleMessageHandleMessageHandleMessageHandlemessageHandlemessage_handle parameter.

TupleDataTupleDataTupleDataTupleDatatupleDatatuple_data including strings is copied by the operation, and can thus be immediately reused. An empty tuple is considered as a valid value that can be associated with the key. If any data (tuple or object) was already associated with given key (KeyKeyKeyKeykeykey), the old data is destroyed by set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTupleset_message_tuple and replaced by TupleDataTupleDataTupleDataTupleDatatupleDatatuple_data.

The KeyKeyKeyKeykeykey has to be a string or an integer. String keys are treated case sensitive.

The tuple data for the given key can be retrieved again from the message using get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTupleget_message_tuple.

注意

Note that if the tuple contains any handles (which are treated as simple integers) only the handle values are copied by the operation, not the resources behind those handles.

运行信息

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

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)

create_message (Message)
set_message_tuple (Message, 'simple_integer', 27)
set_message_tuple (Message, 'simple_string', 'Hello world')
set_message_tuple (Message, 'mixed_tuple', ['The answer', 42])

结果

If the operation succeeds, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTupleset_message_tuple returns 2 ( H_MSG_TRUE) . Otherwise an exception is raised. Possible error conditions include invalid parameters (handle or key) or resource allocation error.

可能的前置算子

create_messagecreate_messageCreateMessageCreateMessageCreateMessagecreate_message

可能的后置算子

enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessageenqueue_message, set_message_objset_message_objSetMessageObjSetMessageObjSetMessageObjset_message_obj

可替代算子

set_message_objset_message_objSetMessageObjSetMessageObjSetMessageObjset_message_obj

参考其它

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

模块

Foundation

---