get_message_tupleT_get_message_tupleGetMessageTupleGetMessageTupleget_message_tuple (Operator)

Name

get_message_tupleT_get_message_tupleGetMessageTupleGetMessageTupleget_message_tuple — Zurückgeben der in einer Nachricht über einen Schüssel referenzierten Tupeldaten.

Signatur

get_message_tuple( : : MessageHandle, Key : TupleData)

Beschreibung

get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleget_message_tuple fragt aus einer Nachricht MessageHandleMessageHandleMessageHandlemessageHandlemessage_handle die mit einem Schlüssel KeyKeyKeykeykey assoziierten Tupeldaten TupleDataTupleDataTupleDatatupleDatatuple_data ab. Die Tupeldaten müssen zuvor mit Hilfe des Operators set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleset_message_tuple in dem Nachrichtenobjekt abgespeichert worden sein.

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

MessageHandleMessageHandleMessageHandlemessageHandlemessage_handle (input_control) message → (handle)

Nachrichtenobjekt.

Parameteranzahl: MessageHandle == 1

Restriktion: MessageHandle != 0

KeyKeyKeykeykey (input_control) string → (string / integer)

Schlüsselwort oder Integer.

Parameteranzahl: Key == 1

TupleDataTupleDataTupleDatatupleDatatuple_data (output_control) tuple(-array) → (string / integer / real / handle)

Vom Schlüssel referenzierte Tupeldaten.

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_tuple (Message,'simple_string',TupleString)

Ergebnis

Im Erfolgsfall gibt get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleget_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), Abwesenheit des Schlüssels in der Nachricht oder wenn der Schüssel andere Datentypen als ein Datentupel referenziert.

Vorgänger

dequeue_messagedequeue_messageDequeueMessageDequeueMessagedequeue_message

Alternativen

get_message_objget_message_objGetMessageObjGetMessageObjget_message_obj

Siehe auch

create_messagecreate_messageCreateMessageCreateMessagecreate_message, clear_messageclear_messageClearMessageClearMessageclear_message, set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleset_message_tuple, set_message_objset_message_objSetMessageObjSetMessageObjset_message_obj, get_message_objget_message_objGetMessageObjGetMessageObjget_message_obj, set_message_paramset_message_paramSetMessageParamSetMessageParamset_message_param, get_message_paramget_message_paramGetMessageParamGetMessageParamget_message_param, enqueue_messageenqueue_messageEnqueueMessageEnqueueMessageenqueue_message, dequeue_messagedequeue_messageDequeueMessageDequeueMessagedequeue_message

Modul

Foundation

Operatoren