set_message_obj
— Hinzufügen eines Schlüssel-Objekt-Paares zu einem Nachrichtenobjekt.
set_message_obj(ObjectData : : MessageHandle, Key : )
set_message_obj
speichert in einer Nachricht ähnlich zu
einem assoziativem Array ein ikonisches Objekt in Verbindung mit
einem Schlüssel ab. Das Nachrichtenobjekt wird im Parameter
MessageHandle
übergeben.
ObjectData
wird durch die Operation kopiert (vgl. copy_obj
)
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üssel referenziert
werden. Falls bereits Daten (Tupel oder Objekt) durch den gegebenen
Schlüssel referenziert werden, werden die alten Daten freigegeben
und durch ObjectData
ersetzt.
Key
ist ein String oder ein Integer, wobei bei
Strings die Groß-/Kleinschreibung beachtet wird.
Die ikonischen Objekte für den
übergebenen Schlüssel können mit Hilfe des Operators
get_message_obj
aus dem Nachrichtenobjekt wieder ausgelesen
werden.
Dieser Operator modifiziert den Zustand des folgenden Eingabeparameters:
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.
ObjectData
(input_object) object(-array) →
object
Vom Schlüssel zu referenzierendes ikonisches Objekt.
MessageHandle
(input_control, Zustand wird modifiziert) message →
(handle)
Nachrichtenobjekt.
Parameteranzahl: MessageHandle == 1
Restriktion: MessageHandle != 0
Key
(input_control) string →
(string / integer)
Schlüsselwort oder Integer.
Parameteranzahl: Key == 1
create_message (Message) read_image( Image, 'filename') set_message_obj (Image, Message, 'my_image')
Im Erfolgsfall gibt set_message_tuple
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.
enqueue_message
,
set_message_tuple
create_message
,
clear_message
,
set_message_tuple
,
get_message_tuple
,
get_message_obj
,
set_message_param
,
get_message_param
,
enqueue_message
,
dequeue_message
Foundation