get_message_objT_get_message_objGetMessageObjGetMessageObj (Operator)

Name

get_message_objT_get_message_objGetMessageObjGetMessageObj — Zurückgeben der in einer Nachricht von einem Schlüssel referenzierten ikonischen Objekte.

Signatur

get_message_obj( : ObjectData : MessageHandle, Key : )

Beschreibung

get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObj fragt aus einer Nachricht MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle das mit einem Schlüssel KeyKeyKeyKeykey assoziierte ikonische Objekt ObjectDataObjectDataObjectDataObjectDataobjectData ab. Das ikonische Objekt muss zuvor mit Hilfe des Operators set_message_objset_message_objSetMessageObjSetMessageObjSetMessageObj in dem Nachrichtenobjekt abgespeichert worden sein.

Falls der spezifizierte Schlüssel KeyKeyKeyKeykey nicht in dem Nachrichtenobjekt hinterlegt ist oder die mit ihm verbundenen Daten kein ikonisches Objekt sondern ein Datentupel ist, schlägt get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObj fehl. Die gespeicherten Schlüssel und die Information über die von ihnen referenzierten Daten kann über den Operator get_message_paramget_message_paramGetMessageParamGetMessageParamGetMessageParam abgefragt 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.

Parameter

ObjectDataObjectDataObjectDataObjectDataobjectData (output_object) object(-array) → object

Vom Schlüssel referenziertes Objekt.

MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle (input_control) message → (handle)

Nachrichtenobjekt.

Parameteranzahl: MessageHandle == 1

Restriktion: MessageHandle != 0

KeyKeyKeyKeykey (input_control) string → (string / integer)

Schlüsselwort oder Integer.

Parameteranzahl: Key == 1

Beispiel (HDevelop)

* ...
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')

Ergebnis

Im Erfolgsfall gibt get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObj 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.

Vorgänger

dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage

Alternativen

get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTuple

Siehe auch

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

Modul

Foundation

Operatoren