get_dict_param
— Abfragen von Parametern oder Informationen eines Dictionaries.
get_dict_param( : : DictHandle, GenParamName, Key : GenParamValue)
get_dict_param
fragt die aktuellen Werte der Parameter
eines Dictionaries oder anderweitige Informationen zum Status eines
Dictionaries ab.
Jeder Aufruf von get_dict_param
darf nur einen einzelnen
Parameternamen in GenParamName
enthalten. Es gibt
zwei unterschiedliche Arten von Abfragen:
Parameter, die auf das gesamte Dictionary 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 einzelne 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, für die in dem Dictionary Daten hinterlegt
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 oder Integern 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 zu dem übergebenen Schlüssel in dem
Dictionary Daten hinterlegt sind, 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 dem
Dictionary Tupeldaten referenzieren. Die Tupeldaten selbst erhält
man mit dem Operator get_dict_tuple
. Der Wert
'object' wird für Schlüssel zurückgegeben, welche
Objektdaten referenzieren. Die Objektdaten selbst werden vom
Operator get_dict_object
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_dict_tuple
oder get_dict_object
verwendet
werden muss um die Daten eines speziellen Schlüssels zu
erhalten.
DictHandle
(input_control) dict →
(handle)
Handle des Dictionaries.
Parameteranzahl: DictHandle == 1
GenParamName
(input_control) string →
(string)
Name des Parameters.
Parameteranzahl: GenParamName == GenParamValue
Defaultwert: 'keys'
Werteliste: 'key_data_type' , 'key_exists' , 'keys'
Key
(input_control) string(-array) →
(string / integer)
Schlüssel auf den der Parameter angewendet werden
soll (leer für GenParamName
= 'keys' ).
GenParamValue
(output_control) tuple(-array) →
(string / integer / real)
Wert der Parameterabfrage.
get_dict_param (Dict, 'keys', [], AllKeys) get_dict_param (Dict, 'key_data_type', AllKeys, KeysType)
Wenn alle Parameter und übergebenen Schlüssel gültig sind, gibt
get_dict_param
den Wert 2 (H_MSG_TRUE) zurück. Andernfalls wird
eine Fehlerbehandlung durchgeführt.
create_dict
,
set_dict_tuple
,
get_dict_tuple
,
set_dict_object
,
get_dict_object
,
remove_dict_key
Foundation