get_message_tupleT_get_message_tupleGetMessageTupleGetMessageTuple (Operator)

Name

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

Signatur

get_message_tuple( : : MessageHandle, Key : TupleData)

Beschreibung

get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTuple fragt aus einer Nachricht MessageHandleMessageHandleMessageHandleMessageHandlemessageHandle die mit einem Schlüssel KeyKeyKeyKeykey assoziierten Tupeldaten TupleDataTupleDataTupleDataTupleDatatupleData ab. Die Tupeldaten müssen zuvor mit Hilfe des Operators set_message_tupleset_message_tupleSetMessageTupleSetMessageTupleSetMessageTuple 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_tupleGetMessageTupleGetMessageTupleGetMessageTuple 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

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

TupleDataTupleDataTupleDataTupleDatatupleData (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_tupleGetMessageTupleGetMessageTupleGetMessageTuple 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_messageDequeueMessageDequeueMessageDequeueMessage

Alternativen

get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObj

Siehe auch

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

Modul

Foundation

Operatoren