get_message_param
— Abfragen von Parametern oder Information zu einer Nachricht.
get_message_param( : : MessageHandle, GenParamName, Key : GenParamValue)
get_message_param
fragt die aktuellen Werte der Parameter
einer Nachricht oder anderweitige Informationen zum Status einer
Nachricht ab.
Jeder Aufruf von get_message_param
darf nur einen einzelnen
Parameternamen in GenParamName
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 Key
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
Key
übergeben werden, auf die der Parameter angewendet
werden soll. Die Schlüssel werden dabei in der gleichen Reihenfolge
abgearbeitet wie sie dem Parameter Key
übergeben werden.
Parameternamen, die unabhängig von Schlüsseln angewendet werden:
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 GenParamValue
als ein Tupel von Strings zurückgegeben.
Für diese Abfrage muss dem Parameter Key
ein leeres Tupel
übergeben werden.
Parametername, die Schlüssel-spezifisch angewendet werden:
Gibt 1 zurück, wenn der übergebenen Schlüssel in der
spezifizierten Nachricht gespeichert ist, sonst 0. Die
Ergebnisse werden im Parameter GenParamValue
zurückgegeben,
jeweils ein Wert pro übergebenem Schlüssel.
Gibt den Wert 'tuple' für Schlüssel zurück, die in der
Nachricht Tupeldaten referenzieren. Die Tupeldaten selbst erhält
man mit dem Operator get_message_tuple
. Der Wert
'object' wird für Schlüssel zurückgegeben, welche
Objektdaten referenzieren. Die Objektdaten selbst werden vom
Operator get_message_obj
zurückgegeben. Die Ergebnisse
werden im Parameter GenParamValue
zurückgegeben,
jeweils ein Wert pro Schlüssel. Dieser Parameter kann
verwendet werden um dynamisch zu entscheiden, ob
get_message_tuple
oder get_message_obj
verwendet
werden muss um die Daten eines speziellen Schlüssels zu
erhalten.
MessageHandle
(input_control) message →
(handle)
Nachrichtenobjekt.
Parameteranzahl: MessageHandle == 1
Restriktion: MessageHandle != 0
GenParamName
(input_control) string →
(string)
Name des Parameters.
Parameteranzahl: GenParamName == GenParamValue
Defaultwert: 'message_keys'
Werteliste: 'key_data_type' , 'key_exists' , 'message_keys'
Key
(input_control) string(-array) →
(string / integer)
Schlüssel auf das der Parameter angewendet werden soll.
GenParamValue
(output_control) tuple(-array) →
(string / integer / real)
Wert der Parameterabfrage.
get_message_param (Message, 'message_keys', [], AllKeys) get_message_param (Message, 'key_data_type', AllKeys, KeysType)
Wenn alle Parameter und übergebenen Schlüssel gültig sind, gibt
get_message_param
den Wert 2 (H_MSG_TRUE) zurück. Andernfalls wird
eine Fehlerbehandlung durchgeführt.
create_message
,
clear_message
,
set_message_tuple
,
get_message_tuple
,
set_message_obj
,
get_message_obj
,
set_message_param
,
enqueue_message
,
dequeue_message
Foundation