File-Objekt [AHK_L 42+]

Bietet eine Schnittstelle für die Datei-Ein-/Ausgabe, z.B. das Lesen oder Schreiben von Text oder das Abrufen seiner Länge. FileOpen() gibt ein Objekt dieses Typs zurück.

Inhaltsverzeichnis

Methoden

Read

Liest eine Zeichenkette aus der Datei und rückt den Dateizeiger vor.

Zkette := File.Read(ZeichenAnzahl)

Parameter

ZeichenAnzahl
Wenn weggelassen, wird der Rest der Datei gelesen und als einzelne Zeichenkette zurückgegeben. Wenn leer, wird standardmäßig 0 verwendet. Andernfalls geben Sie die maximale Anzahl der zu lesenden Zeichen an. Wenn das File-Objekt von einem Handle erzeugt wurde, das auf ein nicht-suchendes Device wie Konsolenpuffer oder Pipe verweist, kann das Weglassen dieses Parameters dazu führen, dass die Methode fehlschlägt oder nur die aktuell verfügbaren Daten zurückgibt.

Rückgabewert

Diese Methode gibt die gelesene Zeichenkette zurück.

Write

Schreibt eine Zeichenkette in die Datei und rückt den Dateizeiger vor.

ByesGeschrieben := File.Write(Zkette)

Parameter

Zkette
Die zu schreibende Zeichenkette.

Rückgabewert

Diese Methode gibt die Anzahl der geschriebenen Bytes (nicht Zeichen) zurück.

ReadLine

Liest eine Textzeile aus der Datei und rückt den Dateizeiger vor.

TextZeile := File.ReadLine()

Rückgabewert

Diese Methode gibt eine Textzeile zurück. Die Textzeile kann `n, `r`n oder `r enthalten, abhängig von der Datei und den Zeilenumbruch-Flags, die zum Öffnen der Datei verwendet wurden.

Bemerkungen

Es können Zeilen mit einer Länge von bis zu 65534 Zeichen gelesen werden. Wenn eine Zeile diese Länge überschreitet, wird der Rest der Zeile durch nachfolgende Aufrufe dieser Methode zurückgegeben.

WriteLine

Schreibt eine Textzeile in die Datei und rückt den Dateizeiger vor.

ByesGeschrieben := File.WriteLine(Zkette)

Parameter

Zkette
Wenn leer oder weggelassen, wird eine leere Zeile geschrieben. Andernfalls geben Sie die zu schreibende Zeichenkette an, die immer mit `n oder `r`n endet, abhängig von den Zeilenumbruch-Flags, die zum Öffnen der Datei verwendet wurden.

Rückgabewert

Diese Methode gibt die Anzahl der geschriebenen Bytes (nicht Zeichen) zurück.

ReadZahlTyp

Liest eine Zahl aus der Datei und rückt den Dateizeiger vor.

Zahl := File.ReadZahlTyp()

ZahlTyp ist entweder UInt, Int, Int64, Short, UShort, Char, UChar, Double oder Float. Diese Typnamen haben die gleiche Bedeutung wie bei DllCall().

Rückgabewert

Bei Erfolg gibt diese Methode eine Zahl zurück. Bei Misserfolg gibt sie eine leere Zeichenkette zurück.

Bemerkungen

Wenn eine Try-Anweisung aktiv ist und keine Bytes gelesen wurden, wird eine Ausnahme ausgelöst. Es wird keine Ausnahme ausgelöst, wenn mindestens ein Byte gelesen wurde, selbst wenn die Größe von ZahlTyp größer als die Anzahl der gelesenen Bytes ist. Stattdessen werden die fehlenden Bytes als Null behandelt.

WriteZahlTyp

Schreibt eine Zahl in die Datei und rückt den Dateizeiger vor.

ByesGeschrieben := File.WriteZahlTyp(Zahl)

ZahlTyp ist entweder UInt, Int, Int64, Short, UShort, Char, UChar, Double oder Float. Diese Typnamen haben die gleiche Bedeutung wie bei DllCall().

Parameter

Zahl
Die zu schreibende Zahl.

Rückgabewert

Diese Methode gibt die Anzahl der geschriebenen Bytes zurück. Zum Beispiel gibt File.WriteUInt(42) bei Erfolg 4 zurück.

RawRead

Liest rohe Binärdaten aus der Datei in den Speicher und rückt den Dateizeiger vor.

BytesGelesen := File.RawRead(VarOderAdresse, Bytes)

Parameter

VarOderAdresse
Variable oder Speicheradresse, wohin die Daten kopiert werden sollen. Die Nutzung ähnelt der von NumGet(). Wenn eine Variable angegeben ist, wird sie automatisch erweitert, falls nötig.
Bytes
Die maximale Anzahl der Bytes, die gelesen werden sollen.

Rückgabewert

Diese Methode gibt die Anzahl der gelesenen Bytes zurück.

Bemerkungen

Wenn eine Try-Anweisung aktiv ist und Bytes ungleich 0 ist, aber keine Bytes gelesen wurden, wird eine Ausnahme ausgelöst. Dies lässt sich mit der AtEOF-Eigenschaft vermeiden, falls nötig.

RawWrite

Schreibt rohe Binärdaten in die Datei und rückt den Dateizeiger vor.

ByesGeschrieben := File.RawWrite(VarOderAdresse, Bytes)

Parameter

VarOderAdresse
Eine Variable, die die Daten oder die Adresse der Daten im Speicher enthält. Die Nutzung ähnelt der von NumPut().
Bytes
Die maximale Anzahl der Bytes, die geschrieben werden sollen.

Rückgabewert

Diese Methode gibt die Anzahl der geschriebenen Bytes zurück.

Seek

Verschiebt den Dateizeiger.

Verschoben := File.Seek(Distanz , Startpunkt)

Parameter

Distanz
Die Anzahl der Bytes, um die verschoben werden soll. Je kleiner der Wert, desto näher befindet sich der Dateizeiger am Anfang der Datei.
Startpunkt

Wenn weggelassen, wird standardmäßig 2 verwendet, wenn Distanz negativ ist, andernfalls 0. Andernfalls geben Sie eine der folgenden Zahlen an, um den Startpunkt festzulegen, von dem aus der Dateizeiger verschoben werden soll.

  • 0 (SEEK_SET): Anfang der Datei. Distanz muss 0 oder größer sein.
  • 1 (SEEK_CUR): Aktuelle Position des Dateizeigers.
  • 2 (SEEK_END): Ende der Datei. Distanz sollte normalerweise negativ sein.

Rückgabewert

Bei Erfolg gibt diese Methode 1 (true) zurück. Bei Misserfolg gibt sie 0 (false) zurück.

Bemerkungen

Diese Methode ist äquivalent zu File.Pos := Distanz und File.Position := Distanz, wenn Distanz nicht negativ ist und Startpunkt weggelassen wird oder 0 (SEEK_SET) ist.

Tell

Gibt die aktuelle Position des Dateizeigers zurück, wobei 0 der Anfang der Datei ist.

AktuellePos := File.Tell()

Diese Methode ist äquivalent zu AktuellePos := File.Pos und AktuellePos := File.Position.

Close

Schließt die Datei, entleert alle Daten im Cache auf die Festplatte und hebt Freigabesperren auf.

File.Close()

Obwohl die Datei beim Freigeben des Objekts automatisch geschlossen wird, ist es ratsam, die Datei so früh wie möglich zu schließen.

Eigenschaften

Pos / Position

Ermittelt oder setzt die Position des Dateizeigers.

AktuellePos := File.Pos
AktuellePos := File.Position
File.Pos := NeuePos
File.Position := NeuePos

AktuellePos und NeuePos sind ein Offset vom Anfang der Datei (in Bytes), wobei 0 das erste Byte ist. Wenn Daten in die Datei geschrieben oder aus ihr gelesen werden, verschiebt sich der Dateizeiger automatisch auf das nächste Byte hinter diesen Daten.

Diese Eigenschaft ist äquivalent zu AktuellePos := File.Tell() und File.Seek(NeuePos).

Length

Ermittelt oder setzt die Größe der Datei.

AktuelleGröße := File.Length
File.Length := NeueGröße

AktuelleGröße und NeueGröße sind die Größe der Datei in Bytes.

Diese Eigenschaft sollte nur mit einer echten Datei verwendet werden. Wenn das File-Objekt von einem Handle erzeugt wurde, das auf ein Pipe verweist, kann Length die Menge der Daten zurückgeben, die gerade im internen Pufferspeicher des Pipe verfügbar sind, aber dieses Verhalten ist nicht garantiert.

AtEOF

Ermittelt eine Zahl ungleich 0, wenn der Dateizeiger das Ende der Datei erreicht hat.

AmEndeDerDatei := File.AtEOF

Diese Eigenschaft sollte nur mit einer echten Datei verwendet werden. Wenn das File-Objekt von einem Handle erzeugt wurde, das auf ein nicht-suchendes Device wie Konsolenpuffer oder Pipe verweist, kann der Rückgabewert bedeutungslos sein, da solche Devices logischerweise kein "End of File" haben.

Encoding

Ermittelt oder setzt die Textkodierung des File-Objekts.

AktuelleKodierung := File.Encoding
File.Encoding := NeueKodierung

AktuelleKodierung und NeueKodierung sind ein numerischer Codepageidentifikator (siehe Microsoft Docs) oder eine der folgenden Zeichenketten:

AktuelleKodierung kann nie ein Wert mit dem Suffix -RAW sein, unabhängig davon, wie die Datei geöffnet wurde oder ob sie eine Byte-Order-Markierung (BOM) enthält. NeueKodierung bewirkt nicht, dass eine BOM hinzugefügt oder entfernt wird, da eine BOM normalerweise beim Erstellen der Datei hinzugefügt wird.

[v1.1.15.04+]: Das Setzen von NeueKodierung auf UTF-8-RAW oder UTF-16-RAW ist erlaubt, aber das Suffix -RAW wird ignoriert. In älteren Versionen verhielten sich UTF-8-RAW und UTF-16-RAW wie eine ungültige 8-Bit-Kodierung, wodurch alle ASCII-fremden Zeichen verworfen wurden. Dies gilt nur für File.Encoding, nicht für FileOpen().

Handle / __Handle

Ermittelt ein System-Datei-Handle, das für DllCall() verwendet werden kann. Siehe CreateFile.

Handle := File.Handle  ; Benötigt [v1.1.35+]
Handle := File.__Handle

File-Objekte puffern intern Lese- und Schreibvorgänge. Daten, die in den internen Pufferspeicher des Objekts geschrieben wurden, werden auf die Festplatte übertragen, bevor das Handle zurückgegeben wird. Enthält der Pufferspeicher Daten, die aus einer Datei gelesen wurden, werden diese verworfen und der Dateizeiger auf die logische Position (widergespiegelt durch die Pos-Eigenschaft) zurückgesetzt.