In AutoHotkey ist der reguläre Objektdatentyp ein assoziatives Array, dessen Verhalten individuell angepasst werden kann. Standardmäßig unterstützen alle Objekte, die mit {}, [], Object() und Array() erstellt wurden, die folgenden Methoden, Eigenschaften und Funktionen.
Fügt einen oder mehrere Werte an einer Position innerhalb eines linearen Arrays ein.
Objekt.InsertAt(Pos, Wert1 , Wert2, ... WertN)
Die Position, an der Wert1 eingefügt werden soll. Nachfolgende Werte werden an Pos+1, Pos+2 usw. eingefügt.
Ein oder mehrere Werte, die eingefügt werden sollen. Um ein Array von Werten einzufügen, übergeben Sie dasArray* als letzten Parameter.
InsertAt ist das Gegenstück zu RemoveAt.
Da Objekte assoziative Arrays sind, ist Pos außerdem der Integerschlüssel, der Wert1 zugeordnet wird. Alle Elemente, die sich an oder rechts von Pos befinden, werden um genau die Anzahl der Wertparameter nach rechts verschoben, selbst wenn einige Werte fehlen (d.h. wenn das Objekt ein lückenhaftes Array ist). Zum Beispiel:
x := [] x.InsertAt(1, "A", "B") ; => ["A", "B"] x.InsertAt(2, "C") ; => ["A", "C", "B"] ; Lückenhafte/leere Elemente bleiben erhalten: x := ["A", , "C"] x.InsertAt(2, "B") ; => ["A", "B", , "C"] x := ["C"] x.InsertAt(1, , "B") ; => [ , "B", "C"]
InsertAt sollte nur verwendet werden, wenn die Integerschlüssel des Objekts Positionen in einem linearen Array repräsentieren. Wenn das Objekt willkürliche Integerschlüssel wie IDs oder Handles enthält, wird InsertAt wahrscheinlich unerwünschte Nebeneffekte haben. Zum Beispiel:
x := [], handleX := 0x4321, handleY := 0x1234 x.InsertAt(handleX, "A") MsgBox % x[handleX] ; A - Okay x.InsertAt(handleY, "B") MsgBox % x[handleX] ; Leer MsgBox % x[handleX+1] ; Dies ist die neue "Position" von "A"
InsertAt hat keinen Effekt auf Zeichenketten- oder Objektschlüssel und kann daher problemlos für Objekte mit unterschiedlichen Schlüsseltypen verwendet werden.
Entfernt Elemente an einer Position innerhalb eines linearen Arrays.
Objekt.RemoveAt(Pos , Länge)
Die Position eines oder mehrerer Werte, die entfernt werden sollen.
Die Länge des Wertebereichs, der entfernt werden soll. Es werden die Elemente von Pos bis Pos+Länge-1 entfernt. Wenn weggelassen, wird nur ein Element entfernt.
Wenn Länge weggelassen wird, wird der an Pos entfernte Wert zurückgegeben (leer, wenn es keinen gibt). Andernfalls ist der Rückgabewert die Anzahl der entfernten Elemente, die Werte enthielten. Die Anzahl kann bei einem lückenhaften Array von Länge abweichen, liegt aber immer im Bereich von 0 bis Länge.
RemoveAt ist das Gegenstück zu InsertAt.
Die restlichen Elemente rechts von Pos werden um den via Länge definierten Wert (oder standardmäßig um 1) nach links verschoben, selbst wenn einige Elemente im entfernten Bereich keine Werte haben. Zum Beispiel:
x := ["A", "B"] MsgBox % x.RemoveAt(1) ; A MsgBox % x[1] ; B x := ["A", , "C"] MsgBox % x.RemoveAt(1, 2) ; 1 MsgBox % x[1] ; C
RemoveAt sollte nur verwendet werden, wenn die Integerschlüssel des Objekts Positionen in einem linearen Array repräsentieren. Wenn das Objekt willkürliche Integerschlüssel wie IDs oder Handles enthält, wird RemoveAt wahrscheinlich unerwünschte Nebeneffekte haben. Zum Beispiel:
x := {0x4321: "A", 0x1234: "B"}
MsgBox % x.RemoveAt(0x1234) ; B
MsgBox % x[0x4321] ; Leer
MsgBox % x[0x4321-1] ; A
RemoveAt hat keinen Effekt auf Zeichenketten- oder Objektschlüssel und kann daher problemlos für Objekte mit unterschiedlichen Schlüsseltypen verwendet werden.
Fügt Werte am Ende eines Arrays an.
Objekt.Push( Wert, Wert2, ..., WertN )
Ein oder mehrere Werte, die eingefügt werden sollen. Um ein Array von Werten einzufügen, übergeben Sie dasArray* als letzten Parameter.
Der Rückgabewert ist die Position des zuletzt eingefügten Wertes. Kann negativ sein, wenn das Array nur Elemente mit negativem Index enthält.
Der erste Wert wird an Position 1 eingefügt, wenn das Array leer ist oder nur Zeichenketten- oder Objektschlüssel enthält.
Andernfalls wird der erste Wert an Objekt.MaxIndex() + 1 eingefügt, selbst wenn diese Position negativ oder Null ist. Wenn dies nicht erwünscht ist und das Objekt negative Schlüssel enthält, kann stattdessen Objekt.InsertAt(Objekt.Length() + 1, ...) verwendet werden.
Entfernt das letzte Array-Element und gibt es zurück.
Wert := Objekt.Pop()
Wenn es keine Array-Elemente gibt, ist der Rückgabewert eine leere Zeichenkette. Andernfalls ist es äquivalent zu:
Wert := Objekt.RemoveAt(Objekt.Length())
Entfernt Schlüssel-Wert-Paare aus einem Objekt.
Objekt.Delete(Schlüssel) Objekt.Delete(ErsterSchlüssel, LetzterSchlüssel)
Ein beliebiger Schlüssel.
Ein gültiger Bereich von Integer- oder Zeichenkettenschlüsseln, wobei ErsterSchlüssel <= LetzterSchlüssel ist. Beide Schlüssel müssen vom selben Typ sein.
Bei nur einem Parameter wird der entfernte Wert zurückgegeben (leer, wenn es keinen gibt). Andernfalls ist der Rückgabewert die Anzahl der gefundenen und entfernten Schlüssel.
Im Gegensatz zu RemoveAt hat Delete keinen Effekt auf Schlüssel-Wert-Paare, die es nicht entfernt. Zum Beispiel:
x := ["A", "B"] MsgBox % x.RemoveAt(1) ; A MsgBox % x[1] ; B x := ["A", "B"] MsgBox % x.Delete(1) ; A MsgBox % x[1] ; Leer
Gibt den niedrigsten/höchsten Integerschlüssel zurück, falls vorhanden.
MinIndex := Objekt.MinIndex() MaxIndex := Objekt.MaxIndex()
Wenn keine Schlüssel vorhanden sind, wird eine leere Zeichenkette zurückgegeben.
Gibt die Länge eines linearen Arrays zurück.
Länge := Objekt.Length()
Diese Methode gibt die Länge eines linearen Arrays zurück, beginnend bei Position 1, d.h. entweder den höchsten positiven Integerschlüssel im Objekt, oder 0, wenn es keinen gibt.
MsgBox % ["A", "B", "C"].Length() ; 3
MsgBox % ["A", , "C"].Length() ; 3
MsgBox % {-10: 0, 10: 0}.Length() ; 10
MsgBox % {-10: 0, -1: 0}.Length() ; 0
Gibt die Anzahl der Schlüssel-Wert-Paare in einem Objekt zurück.
Anzahl := Objekt.Count()
Beispiele:
MsgBox % {A: 1, Z: 26}.Count() ; 2
MsgBox % ["A", "B", "C"].Count() ; 3
MsgBox % ["A", , "C"].Count() ; 2
Passt die Kapazität eines Objekts oder eines seiner Felder an.
Objekt.SetCapacity(MaxElemente) Objekt.SetCapacity(Schlüssel, ByteGröße)
Die maximale Anzahl von Schlüssel-Wert-Paaren, die das Objekt enthalten kann, bevor es automatisch erweitert werden muss. Wenn diese Anzahl kleiner als die aktuelle Anzahl von Schlüssel-Wert-Paaren ist, wird stattdessen dieser Wert verwendet und ungenutzter Speicher freigegeben.
Ein gültiger Schlüssel.
Die neue Größe in Bytes für den Zeichenkettenpuffer des Feldes, ohne den Null-Terminator. Wenn das Feld nicht existiert, wird es erstellt. Wenn ByteGröße 0 ist, wird der Pufferspeicher freigegeben, aber das leere Feld nicht entfernt. Wenn ByteGröße kleiner als die aktuelle Größe ist, werden überschüssige Daten abgeschnitten; andernfalls werden alle vorhandenen Daten beibehalten.
Der Rückgabewert ist bei Erfolg die neue Kapazität, andernfalls eine leere Zeichenkette.
Gibt die Kapazität eines Objekts oder eines seiner Felder zurück.
MaxElemente := Objekt.GetCapacity() ByteGröße := Objekt.GetCapacity(Schlüssel)
Wenn das Feld nicht existiert oder keine Zeichenkette enthält, wird eine leere Zeichenkette zurückgegeben.
Gibt die aktuelle Adresse des Zeichenkettenpuffers eines Feldes zurück.
Ptr := Objekt.GetAddress(Schlüssel)Gibt einen neuen Enumerator zum Enumerieren von Schlüssel-Wert-Paaren eines Objekts zurück.
Enum := Objekt._NewEnum()
Diese Methode wird normalerweise nicht direkt aufgerufen, sondern über die For-Schleife.
Gibt 1 (true) zurück, wenn einem Schlüssel ein Wert (auch "") innerhalb eines Objekts zugeordnet ist, andernfalls 0 (false).
Objekt.HasKey(Schlüssel)Gibt eine flache Kopie eines Objekts zurück.
Klon := Objekt.Clone()Fügt Schlüssel-Wert-Paare in das Objekt ein, und passt existierende Schlüssel automatisch an, wenn ein Integerschlüssel angegeben ist.
Objekt.Insert(Pos, Wert1 , Wert2, ... WertN ) Objekt.Insert(Wert) Objekt.Insert(ZketteOderObjektSchlüssel, Wert)
Das Verhalten von Insert hängt von der Anzahl und dem Typ seiner Parameter ab:
Insert gibt 1 (true) zurück. In [v1.1.21+] wird eine Ausnahme ausgelöst, wenn eine Speicherreservierung fehlschlägt. Ältere Versionen gaben in diesem Fall eine leere Zeichenkette zurück.
Entfernt Schlüssel-Wert-Paare aus einem Objekt.
Objekt.Remove(ErsterSchlüssel, LetzterSchlüssel)
Das Verhalten von Remove hängt von der Anzahl und dem Typ seiner Parameter ab:
Objekt.Remove(Integer) verhält sich wie Objekt.RemoveAt(Integer).Objekt.Remove(Integer, "") verhält sich wie Objekt.Delete(Integer).Objekt.Remove(Integer1, Integer2) verhält sich wie Objekt.RemoveAt(Integer1, Integer2 - Integer1 + 1).Objekt.Remove() verhält sich wie Objekt.Pop().Ermittelt oder setzt das Basisobjekt eines Objekts.
Basisobjekt := Objekt.Base
Objekt.Base := Basisobjekt
Basisobjekt muss ein Objekt oder eine leere Zeichenkette sein.
Eigenschaften und Methoden, die via Basisobjekt definiert werden, sind nur während der Nutzung dieses Basisobjekts zugänglich. Eine Änderung der Basis von Objekt verändert daher auch die verfügbaren Eigenschaften und Methoden.
Siehe auch: ObjGetBase(), ObjSetBase()
Ruft den Wert ab, der einem Schlüssel in einem Objekt zugeordnet ist.
Wert := ObjRawGet(Objekt, Schlüssel)
Wenn Objekt den Schlüssel nicht enthält, ist der Rückgabewert eine leere Zeichenkette. Es werden keine Metafunktionen oder Eigenschaftsfunktionen aufgerufen. Der Inhalt der Basisobjekte von Objekt wird nicht berücksichtigt, und da base selbst standardmäßig eine Eigenschaft ist (kein Schlüssel-Wert-Paar), wird es typischerweise nicht zurückgegeben.
Es wird eine Ausnahme ausgelöst, wenn Objekt vom falschen Typ ist.
Speichert oder überschreibt ein Schlüssel-Wert-Paar in einem Objekt.
ObjRawSet(Objekt, Schlüssel, Wert)
Mit dieser Funktion können Skripte die __Set-Metafunktion und Eigenschaften umgehen. Wenn dies nicht erforderlich ist, verwenden Sie stattdessen eine normale Zuweisung. Zum Beispiel: Objekt[Schlüssel] := Wert
Da der Zweck darin besteht, Metafunktionen zu umgehen, handelt es sich hierbei nur um eine Funktion, nicht um eine Methode. Der Aufruf einer internen Methode bewirkt in der Regel, dass die __Call-Metafunktion aufgerufen wird.
Es wird eine Ausnahme ausgelöst, wenn Objekt vom falschen Typ ist.
Gibt das Basisobjekt eines Objekts zurück.
Basisobjekt := ObjGetBase(Objekt)
Es werden keine Metafunktionen aufgerufen. Die Basis des Objekts wird sogar zurückgegeben, wenn der Schlüssel "base" im Objekt gespeichert wurde (z.B. mit ObjRawSet oder SetCapacity). Es wird eine leere Zeichenkette zurückgegeben, wenn das Objekt keine Basis hat.
Es wird eine Ausnahme ausgelöst, wenn Objekt vom falschen Typ ist.
Siehe auch: Base-Eigenschaft
Setzt das Basisobjekt eines Objekts.
ObjSetBase(Objekt, Basisobjekt)
Es werden keine Metafunktionen aufgerufen. Die Basis des Objekts wird sogar gesetzt, wenn der Schlüssel "base" im Objekt gespeichert wurde (z.B. mit ObjRawSet oder SetCapacity). Es wird eine leere Zeichenkette zurückgegeben, wenn das Objekt keine Basis hat.
Es wird eine Ausnahme ausgelöst, wenn Objekt vom falschen Typ ist oder wenn Basisobjekt kein Objekt oder eine leere Zeichenkette ist.
Siehe auch: Base-Eigenschaft
Jede Methode hat außerdem eine äquivalente Funktion, mit der ein vom Objekt implementiertes benutzerdefiniertes Verhalten umgangen werden kann. Diese Funktionen sollten nur für diesen Zweck verwendet werden. Um eine solche Funktion aufzurufen, stellen Sie dem Methodennamen "Obj" voran und übergeben Sie das Zielobjekt als ersten Parameter. Zum Beispiel:
array := [1, 2, 3] MsgBox % ObjMaxIndex(array) " = " array.MaxIndex()
Wenn eine solche Funktion mit einem Objekt oder Wert vom falschen Typ aufgerufen wird, gibt sie eine leere Zeichenkette zurück. Unabhängige Funktionen wie ObjRawSet lösen eine Ausnahme aus.