Microsoft Small Basic


File

Das File-Objekt bietet Methoden für Lese- und Schreibzugriff auf eine Datei auf einem Datenträger. Mit Hilfe dieses Objekts ist es möglich, Einstellungen über mehrere Sitzungen eines Programms hinweg zu speichern.

Properties

LastError

File.LastError

Ruft die letzte auf einem Dateivorgang basierende Fehlermeldung ab oder legt diese fest. Diese Eigenschaft ist nützlich, wenn man herausfinden möchte, ob eine Methode nicht ausgeführt werden konnte.

Operations

ReadContents

File.ReadContents(filePath)

Öffnet eine Datei und liest deren Inhalt. Diese Methode ist schnell bei Dateien unter 1MB, wird allerdings deutlich langsamer bei größeren Dateien, besonders wenn die Größe 10MB überschreitet.

filePath

Der vollständige Pfad der zu lesenden Datei. Ein Beispiel für einen Pfad wäre c:\temp\settings.data.

Returns

Der gesamte Inhalt der Datei.

WriteContents

File.WriteContents(filePath, contents)

Öffnet eine Datei und schreibt den angegebenen Inhalt in sie. Die aktuellen Inhalte werden durch den neuen Inhalt ersetzt.

filePath

Der vollständige Pfad der zu schreibenden Datei. Ein Beispiel für einen Pfad wäre c:\temp\settings.data.

contents

Die in die angegebene Datei zu schreibenden Inhalte.

Returns

Wenn der Vorgang erfolgreich war, wird "SUCCESS" zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

ReadLine

File.ReadLine(filePath, lineNumber)

Öffnet die angegebene Datei und liest die Inhalte der Zeile mit der angegebenen Zeilennummer.

filePath

Der vollständige Pfad der zu lesenden Datei. Ein Beispiel für einen Pfad wäre c:\temp\settings.data.

lineNumber

Die Zeilennummer des einzulesenden Textes.

Returns

Der Text in der angegebenen Zeile der angegebenen Datei.

WriteLine

File.WriteLine(filePath, lineNumber, contents)

Öffnet die angegebene Datei und schreibt die Inhalte in die Zeile mit der angegebenen Zeilennummer. Dieser Vorgang überschreibt sämtliche bestehenden Inhalte in der angegebenen Zeile.

filePath

Der vollständige Pfad der zu lesenden Datei. Ein Beispiel für einen Pfad ist c:\temp\settings.data.

lineNumber

Die Zeilennummer des zu schreibenden Textes.

contents

Die Inhalte, die in der angegebenen Zeile der angegebenen Datei zu schreiben sind.

Returns

Wenn der Vorgang erfolgreich war, wird "SUCCESS" zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

InsertLine

File.InsertLine(filePath, lineNumber, contents)

Öffnet die angegebene Datei und fügt die Inhalte in der Zeile mit der angegebenen Zeilennummer ein. Dieser Vorgang überschreibt keine bestehenden Inhalte in der angegebenen Zeile.

filePath

Der vollständige Pfad der zu lesenden Datei. Ein Beispiel für einen Pfad ist c:\temp\settings.data.

lineNumber

Die Zeilennummer des einzufügenden Textes.

contents

Die in die Datei einzufügenden Inhalte.

Returns

Wenn der Vorgang erfolgreich war, wird "SUCCESS" zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

AppendContents

File.AppendContents(filePath, contents)

Öffnet die angegebene Datei und hängt die Inhalte an das Ende der Datei an.

filePath

Der vollständige Pfad der zu lesenden Datei. Ein Beispiel für einen Pfad ist c:\temp\settings.data.

contents

Der Inhalt, welcher an das Ende der Datei anzuhängen ist.

Returns

Wenn der Vorgang erfolgreich war, wird "SUCCESS" zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

CopyFile

File.CopyFile(sourceFilePath, destinationFilePath)

Kopiert die angegebene Quelldatei in den Zieldateipfad. Falls der Zielpfad nicht existiert, dann versucht diese Methode, ihn automatisch zu erstellen. Existierende Dateien werden überschrieben. Es empfiehlt sich zu überprüfen, ob die Zieldatei existiert, um eine Überschreibung zu vermeiden.

sourceFilePath

Der vollständige Pfad der zu kopierenden Datei. Ein Beispiel für einen Pfad wäre c:\temp\settings.data.

destinationFilePath

Der Zielort oder Dateipfad.

Returns

Wenn der Vorgang erfolgreich war, wird "SUCCESS" zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

DeleteFile

File.DeleteFile(filePath)

Löscht die angegebene Datei.

filePath

Der Zieldateipfad. Ein Beispiel für einen Pfad wäre c:\temp\settings.data.

Returns

Wenn der Vorgang erfolgreich war, wird "SUCCESS" zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

CreateDirectory

File.CreateDirectory(directoryPath)

Erstellt das angegebene Verzeichnis.

directoryPath

Der vollständige Pfad des zu erstellenden Verzeichnisses.

Returns

Wenn der Vorgang erfolgreich war, wird "SUCCESS" zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

DeleteDirectory

File.DeleteDirectory(directoryPath)

Entfernt das angegebene Verzeichnis.

directoryPath

Der komplette Pfad des zu entfernenden Verzeichnisses.

Returns

Wenn der Vorgang erfolgreich war, wird "SUCCESS" zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

GetFiles

File.GetFiles(directoryPath)

Ruft den Pfad aller Dateien im angegebenen Zielpfad ab.

directoryPath

Das Verzeichnis, in welchem Dateien gesucht werden sollen.

Returns

Wenn der Vorgang erfolgreich war, werden die Dateien als Array zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

GetDirectories

File.GetDirectories(directoryPath)

Ruft den Pfad aller Verzeichnisse im angegebenen Zielpfad ab.

directoryPath

Das Verzeichnis, in welchem nach Unterverzeichnissen gesucht werden soll.

Returns

Wenn der Vorgang erfolgreich war, werden die Verzeichnisse als Array zurückgegeben. Andernfalls wird "FAILED" zurückgegeben.

GetTemporaryFilePath

File.GetTemporaryFilePath()

Erstellt eine neue temporäre Datei in einem temporären Verzeichnis und gibt den vollständigen Dateipfad zurück.

Returns

Der vollständige Pfad der temporären Datei.

GetSettingsFilePath

File.GetSettingsFilePath()

Ruft den vollständigen Pfad der Einstellungsdatei dieses Programms ab. Der Name der Einstellungsdatei basiert auf dem Namen des Programms und befindet sich im selben Verzeichnis wie das Programm.

Returns

Der vollständige Pfad der Einstellungsdatei dieses Programms.