set_message_objset_message_objSetMessageObjSetMessageObj (Operator)

Name

set_message_objset_message_objSetMessageObjSetMessageObj — Hinzufügen eines Schlüssel-Objekt-Paares zu einem Nachrichtenobjekt.

Signatur

set_message_obj(ObjectData : : MessageHandle, Key : )

set_message_objset_message_objSetMessageObjSetMessageObjSetMessageObj speichert in einer Nachricht ähnlich zu einem assoziativem Array ein ikonisches Objekt in Verbindung mit einem Schlüssel ab. Das Nachrichtenobjekt wird im Parameter MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle übergeben.

ObjectDataObjectDataObjectDataObjectDataobjectData wird durch die Operation kopiert (vgl. copy_objcopy_objCopyObjCopyObjCopyObj) und kann daher anschließend ohne Seiteneffekte weiterverwendet oder gelöscht werden. Sowohl leere Objekte als auch ikonische Tupelobjekte sind zulässig und können von einem Schlüsselwort referenziert werden. Falls bereits Daten (Tupel oder Objekt) durch das gegebene Schlüsselwort referenziert werden, werden die alten Daten freigegeben und durch ObjectDataObjectDataObjectDataObjectDataobjectData ersetzt.

KeyKeyKeyKeykey ist ein nicht leerer String bestehend ausnahmslos aus ASCII-Buchstaben, Zahlen und Unterstrichen, wobei das Schlüsselwort mit einem Buchstaben beginnen muss. Dabei werden Groß-/Kleinschreibung beachtet. Die ikonischen Objekte für den übergebenen Schlüssel können mit Hilfe des Operators get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObj aus dem Nachrichtenobjekt wieder ausgelesen werden.

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

Der Wert dieses Parameters darf nicht über mehrere Threads verwendet werden.

Parameter

ObjectDataObjectDataObjectDataObjectDataobjectData (input_object) object(-array) → object

Vom Schlüssel zu referenzierendes ikonisches Objekt.

MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle (input_control, Zustand wird modifiziert) message → (integer)

Nachrichtenobjekt.

Parameteranzahl: MessageHandle == 1

Restriktion: MessageHandle != 0

KeyKeyKeyKeykey (input_control) string → (string)

Schlüsselwort.

Parameteranzahl: Key == 1

Restriktion: length(Key) > 0

Beispiel (HDevelop)

create_message (Message)
read_image( Image, 'filename')
set_message_obj (Image, Message, 'my_image')

Ergebnis

Im Erfolgsfall gibt set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTuple den Wert 2 (H_MSG_TRUE) zurück. Andernfalls wird eine Fehlerbehandlung durchgeführt. Mögliche Fehler sind ungültige Parameter (Nachrichtenobjekt oder Schlüssel) oder ein Allokierungsfehler.

Vorgänger

create_messagecreate_messageCreateMessageCreateMessageCreateMessage

Nachfolger

enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageEnqueueMessage, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTuple

Alternativen

set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTuple

Siehe auch

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

Modul

Foundation

Operatoren