lookup_value
Description:
Looks up a value in a dictionary Variant.
This function works with dictionaries of the type a{s*} (and equally well with type a{o*}, but we only further discuss the string case for sake of clarity).
In the event that this has the type a{sv}, the expected_type
string specifies what type of value
is expected to be inside of the variant. If the value inside the variant has a different type then null is
returned. In the event that this has a value type other than v then expected_type
must directly
match the value type and it is used to unpack the value directly or an error occurs.
In either case, if key
is not found in this, null is returned.
If the key is found and the value has the correct type, it is returned. If expected_type
was specified then any non-
null return value will have this type.
This function is currently implemented with a linear scan. If you plan to do many lookups then VariantDict may be more efficient.
Parameters:
this |
a dictionary Variant |
key |
the key to look up in the dictionary |
expected_type |
a VariantType, or null |
Returns:
the value of the dictionary key, or null |