set_message_paramT_set_message_paramSetMessageParamSetMessageParam (Operator)

Name

set_message_paramT_set_message_paramSetMessageParamSetMessageParam — Setzen von Parametern oder Ausführen von Kommandos auf einer Nachricht.

Signatur

Beschreibung

set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParam kann Parameter einer Nachricht setzen oder Aktionen auf dieser Nachricht ausführen.

Jeder Aufruf von set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParam darf nur einen einzelnen Parameternamen in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName enthalten. Es gibt zwei unterschiedliche Arten von Parametern/Aktionen:

• Parameter/Aktionen, die auf die gesamte Nachricht angewendete werden können. In diesem Fall dürfen keine Schlüssel spezifiziert werden, d.h. es muss dem Parameter KeyKeyKeyKeykey ein leeres Tupel übergeben werden.

• Parameter/Aktionen, die auf einzelne Schlüssel angewendet werden. In diesem Fall muss eine Tupel von Schlüsseln dem Parameter KeyKeyKeyKeykey übergeben werden. Die Schlüssel werden dann in der selben Reihenfolge abgearbeitet in der sie im Parameter KeyKeyKeyKeykey spezifiziert wurden.

Parameternamen, die unabhängig von Schlüsseln angewendet werden:

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

Entfernt alle Schlüssel die aktuell in der Nachricht gespeichert sind und gibt die von den Schlüsseln referenzierten ikonischen Objekten oder Tupeldaten frei. Als Ergebnis erhält man eine leere Nachricht. Der Parameter GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue wird in diesem Fall ignoriert, während für KeyKeyKeyKeykey ein leeres Tupel übergeben werden muss.

Parametername, die Schlüssel-spezifisch angewendet werden:

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

Entfernt die Schlüssel welche im Parameter KeyKeyKeyKeykey spezifiziert werden und gibt die vom Schlüssel referenzierten ikonischen Objekten oder Tupeldaten frei. Falls ein Fehler während der Verarbeitung eines oder mehrerer Schlüssel auftritt, wird versucht so weit wie möglich alle weiteren Schlüssel zu entfernen bevor der Operator mit dem Fehler zurückkehrt. Der Parameter GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue wird in diesem Fall ignoriert.

Ausführungsinformationen

• Multithreading-Typ: reentrant (läuft parallel zu nicht-exklusiven Operatoren).
• Multithreading-Bereich: global (kann von jedem Thread aufgerufen werden).
• Wird ohne Parallelisierung verarbeitet.

Dieser Operator modifiziert den Zustand des folgenden Eingabeparameters:

• MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle

Während der Ausführung dieses Operators muss der Zugriff auf den Wert dieses Parameters synchronisiert werden, wenn er über mehrere Threads hinweg verwendet wird.

Parameter

Beispiel (HDevelop)

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

Ergebnis

Im Erfolgsfall gibt set_message_paramset_message_paramSetMessageParamSetMessageParamSetMessageParam den Wert 2 (H_MSG_TRUE) zurück. Andernfalls wird eine Fehlerbehandlung durchgeführt.

Vorgänger

dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage, create_messagecreate_messageCreateMessageCreateMessageCreateMessage

Nachfolger

enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessage, clear_messageclear_messageClearMessageClearMessageClearMessage

Siehe auch

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

Modul

Foundation