get_message_obj
— Zurückgeben der in einer Nachricht von einem Schlüssel
referenzierten ikonischen Objekte.
get_message_obj( : ObjectData : MessageHandle, Key : )
get_message_obj
fragt aus einer Nachricht
MessageHandle
das mit einem Schlüssel Key
assoziierte ikonische Objekt ObjectData
ab. Das ikonische
Objekt muss zuvor mit Hilfe des Operators set_message_obj
in dem Nachrichtenobjekt abgespeichert worden sein.
Falls der spezifizierte Schlüssel Key
nicht in dem
Nachrichtenobjekt hinterlegt ist oder die mit ihm verbundenen Daten
kein ikonisches Objekt sondern ein Datentupel ist, schlägt
get_message_obj
fehl. Die gespeicherten Schlüssel und
die Information über die von ihnen referenzierten Daten kann über
den Operator get_message_param
abgefragt werden.
ObjectData
(output_object) object(-array) →
object
Vom Schlüssel referenziertes Objekt.
MessageHandle
(input_control) message →
(handle)
Nachrichtenobjekt.
Parameteranzahl: MessageHandle == 1
Restriktion: MessageHandle != 0
Key
(input_control) string →
(string / integer)
Schlüsselwort oder Integer.
Parameteranzahl: Key == 1
* ... get_message_param (Message,'key_exists',['simple_string','foo','my_image'],\ KeysPresence) get_message_param (Message,'key_data_type',['simple_string','my_image'],\ KeysType) get_message_obj (Image, Message, 'my_image')
Im Erfolgsfall gibt get_message_obj
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), Abwesenheit des Schlüssels in
der Nachricht oder wenn der Schüssel andere Datentypen als ein
ikonisches Objekt referenziert.
create_message
,
clear_message
,
set_message_tuple
,
get_message_tuple
,
set_message_obj
,
set_message_param
,
get_message_param
,
enqueue_message
,
dequeue_message
Foundation