remove_dict_keyT_remove_dict_keyRemoveDictKeyRemoveDictKeyremove_dict_key (Operator)
Name
remove_dict_keyT_remove_dict_keyRemoveDictKeyRemoveDictKeyremove_dict_key — Löschen eines Schlüssels aus einem Dictionary.
Signatur
Herror T_remove_dict_key(const Htuple DictHandle, const Htuple Key)
void RemoveDictKey(const HTuple& DictHandle, const HTuple& Key)
void HDict::RemoveDictKey(const HTuple& Key) const
void HDict::RemoveDictKey(const HString& Key) const
void HDict::RemoveDictKey(const char* Key) const
void HDict::RemoveDictKey(const wchar_t* Key) const
(Nur Windows)
def remove_dict_key(dict_handle: HHandle, key: MaybeSequence[Union[str, int]]) -> None
Beschreibung
remove_dict_keyremove_dict_keyRemoveDictKeyRemoveDictKeyRemoveDictKeyremove_dict_key löscht die in KeyKeyKeyKeykeykey übergebenen Schlüssel aus
dem in DictHandleDictHandleDictHandleDictHandledictHandledict_handle übergebenen Dictionary und gibt die vom Schlüssel
referenzierten ikonischen Objekte oder Tupeldaten frei.
Falls ein Fehler während der Verarbeitung eines oder mehrerer Schlüssel
auftritt, beispielsweise weil ein Schlüssel nicht im Dictionary existiert,
wird versucht, so weit wie möglich alle weiteren Schlüssel zu
entfernen bevor der Operator mit dem entsprechenden Fehler zurückkehrt.
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.
Dieser Operator modifiziert den Zustand des folgenden Eingabeparameters:
Während der Ausführung dieses Operators muss der Zugriff auf den Wert dieses Parameters synchronisiert werden, wenn er über mehrere Threads hinweg verwendet wird.
Parameter
DictHandleDictHandleDictHandleDictHandledictHandledict_handle (input_control, Zustand wird modifiziert) dict → HDict, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle des Dictionaries.
Parameteranzahl: DictHandle == 1
KeyKeyKeyKeykeykey (input_control) string(-array) → HTupleMaybeSequence[Union[str, int]]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)
Zu löschender Schlüssel.
Restriktion: length(Key) > 0
Beispiel (HDevelop)
* Remove all keys
get_dict_param (Dict, 'keys', [], Keys)
remove_dict_key (Dict, Keys)
Ergebnis
Im Erfolgsfall gibt remove_dict_keyremove_dict_keyRemoveDictKeyRemoveDictKeyRemoveDictKeyremove_dict_key den Wert 2 (H_MSG_TRUE) zurück.
Andernfalls wird eine Fehlerbehandlung durchgeführt.
Vorgänger
create_dictcreate_dictCreateDictCreateDictCreateDictcreate_dict
Nachfolger
get_dict_paramget_dict_paramGetDictParamGetDictParamGetDictParamget_dict_param
Siehe auch
create_dictcreate_dictCreateDictCreateDictCreateDictcreate_dict,
set_dict_tupleset_dict_tupleSetDictTupleSetDictTupleSetDictTupleset_dict_tuple,
get_dict_tupleget_dict_tupleGetDictTupleGetDictTupleGetDictTupleget_dict_tuple,
set_dict_objectset_dict_objectSetDictObjectSetDictObjectSetDictObjectset_dict_object,
get_dict_objectget_dict_objectGetDictObjectGetDictObjectGetDictObjectget_dict_object,
get_dict_paramget_dict_paramGetDictParamGetDictParamGetDictParamget_dict_param
Modul
Foundation