get_message_objget_message_objGetMessageObjget_message_objGetMessageObjGetMessageObj (Operator)

Name

get_message_objget_message_objGetMessageObjget_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_objGetMessageObjget_message_objGetMessageObjGetMessageObj fragt aus einer Nachricht MessageHandleMessageHandleMessageHandleMessageHandleMessageHandlemessageHandle das mit einem Schlüssel KeyKeyKeyKeyKeykey assoziierte ikonische Objekt ObjectDataObjectDataObjectDataObjectDataObjectDataobjectData ab. Das ikonische Objekt muss zuvor mit Hilfe des Operators set_message_objset_message_objSetMessageObjset_message_objSetMessageObjSetMessageObj in dem Nachrichtenobjekt abgespeichert worden sein.

Falls der spezifizierte Schlüssel KeyKeyKeyKeyKeykey 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_objGetMessageObjget_message_objGetMessageObjGetMessageObj fehl. Die gespeicherten Schlüsselwörter und die Information über die von ihnen referenzierten Daten kann über den Operator get_message_paramget_message_paramGetMessageParamget_message_paramGetMessageParamGetMessageParam abgefragt werden.

Parallelisierung

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

Parameter

ObjectDataObjectDataObjectDataObjectDataObjectDataobjectData (output_object) object(-array) → object

Vom Schlüssel referenziertes Objekt.

MessageHandleMessageHandleMessageHandleMessageHandleMessageHandlemessageHandle (input_control) message → (integer)

Nachrichtenobjekt.

Parameteranzahl: MessageHandle == 1

Restriktion: MessageHandle != 0

KeyKeyKeyKeyKeykey (input_control) string → (string)

Schlüsselwort.

Parameteranzahl: Key == 1

Restriktion: length(Key) > 0

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_objGetMessageObjget_message_objGetMessageObjGetMessageObj 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_messagecreate_messageCreateMessagecreate_messageCreateMessageCreateMessage, clear_messageclear_messageClearMessageclear_messageClearMessageClearMessage, set_message_tupleset_message_tupleSetMessageTupleset_message_tupleSetMessageTupleSetMessageTuple, get_message_tupleget_message_tupleGetMessageTupleget_message_tupleGetMessageTupleGetMessageTuple, set_message_objset_message_objSetMessageObjset_message_objSetMessageObjSetMessageObj, set_message_paramset_message_paramSetMessageParamset_message_paramSetMessageParamSetMessageParam, get_message_paramget_message_paramGetMessageParamget_message_paramGetMessageParamGetMessageParam, enqueue_messageenqueue_messageEnqueueMessageenqueue_messageEnqueueMessageEnqueueMessage, dequeue_messagedequeue_messageDequeueMessagedequeue_messageDequeueMessageDequeueMessage

Modul

Foundation

Operatoren