get_message_paramT_get_message_paramGetMessageParamGetMessageParam (Operator)

Name

get_message_paramT_get_message_paramGetMessageParamGetMessageParam — Abfragen von Parametern oder Information zu einer Nachricht.

Signatur

Beschreibung

get_message_paramget_message_paramGetMessageParamGetMessageParamGetMessageParam fragt die aktuellen Werte der Parameter einer Nachricht oder anderweitige Informationen zum Status einer Nachricht ab.

Jeder Aufruf von get_message_paramget_message_paramGetMessageParamGetMessageParamGetMessageParam darf nur einen einzelnen Parameternamen in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName enthalten. Es gibt zwei unterschiedliche Arten von Abfragen:

• Parameter, die auf die gesamte Nachricht angewendet werden. In diesem Fall dürfen keine Schlüssel übergeben werden, d.h. dem Parameter KeyKeyKeyKeykey muss ein leeres Tupel übergeben werden.

• Parameter, die auf einen einzelnen Schlüssel angewendet werden. In diesem Fall müssen die Schlüssel in dem Parameter KeyKeyKeyKeykey übergeben werden, auf die der Parameter angewendet werden soll. Die Schlüssel werden dabei in der gleichen Reihenfolge abgearbeitet wie sie dem Parameter KeyKeyKeyKeykey übergeben werden.

Parameternamen, die unabhängig von Schlüsseln angewendet werden:

'message_keys'"message_keys""message_keys""message_keys""message_keys":

Fragt alle Schlüssel ab, die in einer Nachricht gespeichert sind, unabhängig von dem Typ der mit ihnen verbundenen Daten. Die Liste der Schlüssel wird über den Parameter GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue als ein Tupel von Strings zurückgegeben. Für diese Abfrage muss dem Parameter KeyKeyKeyKeykey ein leeres Tupel übergeben werden.

Parametername, die Schlüssel-spezifisch angewendet werden:

'key_exists'"key_exists""key_exists""key_exists""key_exists":

Gibt 1 zurück, wenn der übergebenen Schlüssel in der spezifizierten Nachricht gespeichert ist, sonst 0. Die Ergebnisse werden im Parameter GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue zurückgegeben, jeweils ein Wert pro übergebenem Schlüssel.

'key_data_type'"key_data_type""key_data_type""key_data_type""key_data_type":

Gibt den Wert 'tuple'"tuple""tuple""tuple""tuple" für Schlüssel zurück, die in der Nachricht Tupeldaten referenzieren. Die Tupeldaten selbst erhält man mit dem Operator get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTuple. Der Wert 'object'"object""object""object""object" wird für Schlüssel zurückgegeben, welche Objektdaten referenzieren. Die Objektdaten selbst werden vom Operator get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObj zurückgegeben. Die Ergebnisse werden im Parameter GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue zurückgegeben, jeweils ein Wert pro Schlüssel. Dieser Parameter kann verwendet werden um dynamisch zu entscheiden, ob get_message_tupleget_message_tupleGetMessageTupleGetMessageTupleGetMessageTuple oder get_message_objget_message_objGetMessageObjGetMessageObjGetMessageObj verwendet werden muss um die Daten eines speziellen Schlüssels zu erhalten.

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

Beispiel (HDevelop)

get_message_param (Message, 'message_keys', [], AllKeys)
get_message_param (Message, 'key_data_type', AllKeys, KeysType)

Ergebnis

Wenn alle Parameter und übergebenen Schlüssel gültig sind, gibt get_message_paramget_message_paramGetMessageParamGetMessageParamGetMessageParam den Wert 2 (H_MSG_TRUE) zurück. Andernfalls wird eine Fehlerbehandlung durchgeführt.

Vorgänger

dequeue_messagedequeue_messageDequeueMessageDequeueMessageDequeueMessage

Siehe auch

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

Modul

Foundation