Zum Hauptinhalt springen
Version: 1.24.317.1333

abstract File

Enthält eine Funktionssammlung für Datei-Aktionen

Methoden​

AppendAllBytes()​

static AppendAllBytes(filePath, bytes): Promise<void>

Schreibt das angegebene Bytearray in die Datei oder erstellt diese mit dem entsprechenden Inhalt und schließt die Datei dann.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, die erweitert werden soll.
bytesUint8ArrayDie Bytes, die in die Datei geschrieben werden sollen.

Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion appendAllBytesAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2371


AppendAllLines()​

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

AppendAllLines(filePath, contents)​

static AppendAllLines(filePath, contents): Promise<void>

Schreibt das angegebene Zeichenfolgenarray in die Datei oder erstellt diese mit dem entsprechenden Inhalt und schließt die Datei dann.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, die erweitert werden soll.
contentsstring[]Das Zeichenfolgenarray, das in die Datei geschrieben werden soll.
Rückgabewert​

Promise<void>

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion appendAllLinesAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2225

AppendAllLines(filePath, contents, encoding)​

static AppendAllLines(
filePath,
contents,
encoding): Promise<void>

Schreibt das angegebene Zeichenfolgenarray in die Datei oder erstellt diese mit dem entsprechenden Inhalt und schließt die Datei dann.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, die erweitert werden soll.
contentsstring[]Das Zeichenfolgenarray, das in die Datei geschrieben werden soll.
encodingstringDie auf die Zeichenfolge anzuwendende Codierung.
Rückgabewert​

Promise<void>

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.
encoding ist kein gültiger Codepagename oder die durch name angegebene Codepage wird von der zugrunde liegenden Plattform nicht unterstützt.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion appendAllLinesAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2255


AppendAllText()​

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

AppendAllText(filePath, contents)​

static AppendAllText(filePath, contents): Promise<void>

Erstellt eine neue Datei, schreibt die angegebene Zeichenfolge mit der angegebenen Codierung in die Datei und schließt die Datei dann. Ist die Zieldatei bereits vorhanden, wird sie überschrieben.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstringDie Zeichenfolge, die in die Datei geschrieben werden soll.
Rückgabewert​

Promise<void>

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion appendAllTextAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2080

AppendAllText(filePath, contents, encoding)​

static AppendAllText(
filePath,
contents,
encoding): Promise<void>

Schreibt die angegebene Zeichenfolge mit der angegebenen Codierung in die Datei oder erstellt diese mit dem entsprechenden Inhalt und schließt die Datei dann.

Parameter​
ParameterTypeDescription
filePathstringDie Datei, die erweitert werden soll.
contentsstringDie Zeichenfolge, die in die Datei geschrieben werden soll.
encodingstringDie auf die Zeichenfolge anzuwendende Codierung.
Rückgabewert​

Promise<void>

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.
encoding ist kein gültiger Codepagename oder die durch name angegebene Codepage wird von der zugrunde liegenden Plattform nicht unterstützt.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion appendAllTextAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2109


Copy()​

static Copy(
sourceFilePath,
destFilePath,
overwrite): Promise<void>

Kopiert eine vorhandene Datei in eine neue Datei. Das Überschreiben einer gleichnamigen Datei ist unzulässig

Parameter​

ParameterTypeDescription
sourceFilePathstringDie zu kopierende Datei
destFilePathstringDer Path der Zieldatei. Dabei darf es sich nicht um ein Verzeichnis handeln.
overwritebooleantrue , wenn die Zieldatei überschrieben werden kann, andernfalls false

Rückgabewert​

Promise<void>

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder destFilePath ist schreibgeschützt.

Throws​

ArgumentException - sourceFilePath oder destFilePath sind eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - sourceFilePath oder destFilePath sind null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der in sourceFilePath oder destFilePath angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

FileNotFoundException - sourceFilePath wurde nicht gefunden.

Throws​

IOException - destFilePath ist vorhanden, und overwrite lautet false oder ein E/A-Fehler ist aufgetreten.

Throws​

NotSupportedException - Das Format von sourceFilePath oder destFilePath ist ungültig.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion copyAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1342


Delete()​

static Delete(filePath): Promise<void>

Löscht die angegebene Datei

Parameter​

ParameterTypeDescription
filePathstringDer Pfad zur zu löschenden Datei

Rückgabewert​

Promise<void>

Throws​

ArgumentNullException - filePath ist null

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - Die angegebene Datei wird verwendet.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder filePath ist ein Verzeichnis oder filePath gibt eine schreibgeschützte Datei an.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion deleteAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1454


Exists()​

static Exists(filePath): Promise<boolean>

Gibt true zurück, wenn die angegebene Datei vorhanden ist, andernfalls false

Parameter​

ParameterTypeDescription
filePathstringDer Pfad der geprüft werden soll

Rückgabewert​

Promise<boolean>

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion existsAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1491


GetFileInfo()​

static GetFileInfo(filePath): Promise<FileInfo>

Ruft die Dateiinformationen ab

Parameter​

ParameterTypeDescription
filePathstringPfad zur zu prüfenden Datei

Rückgabewert​

Promise<FileInfo>

Informationen zur angegebenen Datei

Throws​

ArgumentNullException - filePath hat den Wert null.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

ArgumentException - Der Dateiname ist leer, oder er enthält nur Leerräume oder ungültige Zeichen.

Throws​

UnauthorizedAccessException - Der Zugriff auf fileName wird verweigert.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

NotSupportedException - filePath enthält einen Doppelpunkt (:) innerhalb der Zeichenfolge.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getFileInfoAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2427


Move()​

static Move(sourceFilePath, destFilePath): Promise<void>

Verschiebt eine vorhandene Datei in eine neue Datei. Das Überschreiben einer gleichnamigen Datei ist unzulässig

Parameter​

ParameterTypeDescription
sourceFilePathstringDie zu verschiebende Datei
destFilePathstringDer Path der Zieldatei. Dabei darf es sich nicht um ein Verzeichnis handeln.

Rückgabewert​

Promise<void>

Throws​

IOException - Die Zieldatei ist bereits vorhanden.

Throws​

ArgumentNullException - sourceFilePath oder destFilePath sind null

Throws​

ArgumentException - sourceFilePath oder destFilePath sind eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - sourceFilePath wurde nicht gefunden.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der in sourceFilePath oder destFilePath angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

NotSupportedException - Das Format von sourceFilePath oder destFilePath ist ungültig.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion moveAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1400


Open()​

static Open(filePath): Promise<void>

Öffnet die übergebene Datei mit dem in Windows definierten Standard-Programm.
Sollte kein Standard-Program vorhanden sein, wird die Programmauswahl von Windows angezeigt.

Parameter​

ParameterTypeDescription
filePathstringPfad der zu öffnenden Datei

Rückgabewert​

Promise<void>

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion openAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2510


ReadAllBytes()​

static ReadAllBytes(filePath): Promise<Uint8Array>

Öffnet eine Binärdatei, liest den Inhalt der Datei in ein Bytearray ein und schließt dann die Datei.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, die zum Lesen geöffnet werden soll.

Rückgabewert​

Promise<Uint8Array>

Ein Bytearray mit dem Inhalt der Datei.

Throws​

ArgumentNullException - filePath ist null

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder filePath ist ein Verzeichnis oder filePath gibt eine schreibgeschützte Datei an.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

OutOfMemoryException - Wenn nicht mehr genug Speicher zur Verfügung steht um das Array zu erstellen.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion readAllBytesAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1536


ReadAllLines()​

static ReadAllLines(filePath): Promise<string[]>

Öffnet eine Textdatei, liest alle Zeilen der Datei und schließt dann die Datei.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, die zum Lesen geöffnet werden soll.

Rückgabewert​

Promise<string[]>

Ein Zeichenfolgenarray, das alle Zeilen der Datei enthält.

Throws​

ArgumentNullException - filePath ist null

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder filePath ist ein Verzeichnis oder filePath gibt eine schreibgeschützte Datei an.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion readAllLinesAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1664


ReadAllText()​

static ReadAllText(filePath): Promise<string>

Öffnet eine Textdatei, liest alle Zeilen der Datei und schließt dann die Datei.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, die zum Lesen geöffnet werden soll.

Rückgabewert​

Promise<string>

Eine Zeichenfolge, die alle Zeilen der Datei enthält.

Throws​

ArgumentNullException - filePath ist null

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder filePath ist ein Verzeichnis oder filePath gibt eine schreibgeschützte Datei an.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion readAllTextAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1601


WriteAllBytes()​

static WriteAllBytes(filePath, bytes): Promise<void>

Erstellt eine neue Datei, schreibt das angegebene Bytearray in die Datei und schließt die Datei dann.Ist die Zieldatei bereits vorhanden, wird sie überschrieben.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
bytesUint8ArrayDie Bytes, die in die Datei geschrieben werden sollen.

Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion writeAllBytesAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2018


WriteAllLines()​

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

WriteAllLines(filePath, contents)​

static WriteAllLines(filePath, contents): Promise<void>

Erstellt eine neue Datei, schreibt das angegebene Zeichenfolgenarray in die Datei und schließt die Datei dann.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstring[]Das Zeichenfolgenarray, das in die Datei geschrieben werden soll.
Rückgabewert​

Promise<void>

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion writeAllLinesAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1872

WriteAllLines(filePath, contents, encoding)​

static WriteAllLines(
filePath,
contents,
encoding): Promise<void>

Erstellt eine neue Datei, schreibt das angegebene Zeichenfolgenarray in die Datei und schließt die Datei dann.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstring[]Das Zeichenfolgenarray, das in die Datei geschrieben werden soll.
encodingstringDie auf die Zeichenfolge anzuwendende Codierung.
Rückgabewert​

Promise<void>

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.
encoding ist kein gültiger Codepagename oder die durch name angegebene Codepage wird von der zugrunde liegenden Plattform nicht unterstützt.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion writeAllLinesAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1902


WriteAllText()​

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

WriteAllText(filePath, contents)​

static WriteAllText(filePath, contents): Promise<void>

Erstellt eine neue Datei, schreibt die angegebene Zeichenfolge mit der angegebenen Codierung in die Datei und schließt die Datei dann. Ist die Zieldatei bereits vorhanden, wird sie überschrieben.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstringDie Zeichenfolge, die in die Datei geschrieben werden soll.
Rückgabewert​

Promise<void>

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion writeAllTextAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1727

WriteAllText(filePath, contents, encoding)​

static WriteAllText(
filePath,
contents,
encoding): Promise<void>

Erstellt eine neue Datei, schreibt die angegebene Zeichenfolge mit der angegebenen Codierung in die Datei und schließt die Datei dann. Ist die Zieldatei bereits vorhanden, wird sie überschrieben.

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstringDie Zeichenfolge, die in die Datei geschrieben werden soll.
encodingstringDie auf die Zeichenfolge anzuwendende Codierung.
Rückgabewert​

Promise<void>

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.
encoding ist kein gültiger Codepagename oder die durch name angegebene Codepage wird von der zugrunde liegenden Plattform nicht unterstützt.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Deprecated​

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion writeAllTextAsync ersetzt wurde.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1756


appendAllBytesAsync()​

static appendAllBytesAsync(filePath, bytes): Promise<void>

Schreibt das angegebene Bytearray in die Datei oder erstellt diese mit dem entsprechenden Inhalt und schließt die Datei dann.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, die erweitert werden soll.
bytesUint8ArrayDie Bytes, die in die Datei geschrieben werden sollen.

Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2401


appendAllLinesAsync()​

appendAllLinesAsync(filePath, contents)​

static appendAllLinesAsync(filePath, contents): Promise<void>

Schreibt das angegebene Zeichenfolgenarray in die Datei oder erstellt diese mit dem entsprechenden Inhalt und schließt die Datei dann.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, die erweitert werden soll.
contentsstring[]Das Zeichenfolgenarray, das in die Datei geschrieben werden soll.
Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2300

appendAllLinesAsync(filePath, contents, encoding)​

static appendAllLinesAsync(
filePath,
contents,
encoding): Promise<void>

Schreibt das angegebene Zeichenfolgenarray in die Datei oder erstellt diese mit dem entsprechenden Inhalt und schließt die Datei dann.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, die erweitert werden soll.
contentsstring[]Das Zeichenfolgenarray, das in die Datei geschrieben werden soll.
encodingstringDie auf die Zeichenfolge anzuwendende Codierung.
Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.
encoding ist kein gültiger Codepagename oder die durch name angegebene Codepage wird von der zugrunde liegenden Plattform nicht unterstützt.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2329


appendAllTextAsync()​

appendAllTextAsync(filePath, contents)​

static appendAllTextAsync(filePath, contents): Promise<void>

Erstellt eine neue Datei, schreibt die angegebene Zeichenfolge mit der angegebenen Codierung in die Datei und schließt die Datei dann. Ist die Zieldatei bereits vorhanden, wird sie überschrieben.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstringDie Zeichenfolge, die in die Datei geschrieben werden soll.
Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2154

appendAllTextAsync(filePath, contents, encoding)​

static appendAllTextAsync(
filePath,
contents,
encoding): Promise<void>

Schreibt die angegebene Zeichenfolge mit der angegebenen Codierung in die Datei oder erstellt diese mit dem entsprechenden Inhalt und schließt die Datei dann.

Parameter​
ParameterTypeDescription
filePathstringDie Datei, die erweitert werden soll.
contentsstringDie Zeichenfolge, die in die Datei geschrieben werden soll.
encodingstringDie auf die Zeichenfolge anzuwendende Codierung.
Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.
encoding ist kein gültiger Codepagename oder die durch name angegebene Codepage wird von der zugrunde liegenden Plattform nicht unterstützt.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2182


copyAsync()​

static copyAsync(
sourceFilePath,
destFilePath,
overwrite): Promise<void>

Kopiert eine vorhandene Datei in eine neue Datei. Das Überschreiben einer gleichnamigen Datei ist unzulässig

Parameter​

ParameterTypeDescription
sourceFilePathstringDie zu kopierende Datei
destFilePathstringDer Path der Zieldatei. Dabei darf es sich nicht um ein Verzeichnis handeln.
overwritebooleantrue , wenn die Zieldatei überschrieben werden kann, andernfalls false

Rückgabewert​

Promise<void>

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder destFilePath ist schreibgeschützt.

Throws​

ArgumentException - sourceFilePath oder destFilePath sind eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - sourceFilePath oder destFilePath sind null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der in sourceFilePath oder destFilePath angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

FileNotFoundException - sourceFilePath wurde nicht gefunden.

Throws​

IOException - destFilePath ist vorhanden, und overwrite lautet false oder ein E/A-Fehler ist aufgetreten.

Throws​

NotSupportedException - Das Format von sourceFilePath oder destFilePath ist ungültig.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1371


deleteAsync()​

static deleteAsync(filePath): Promise<void>

Löscht die angegebene Datei

Parameter​

ParameterTypeDescription
filePathstringDer Pfad zur zu löschenden Datei

Rückgabewert​

Promise<void>

Throws​

ArgumentNullException - filePath ist null

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - Die angegebene Datei wird verwendet.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder filePath ist ein Verzeichnis oder filePath gibt eine schreibgeschützte Datei an.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1479


existsAsync()​

static existsAsync(filePath): Promise<boolean>

Gibt true zurück, wenn die angegebene Datei vorhanden ist, andernfalls false

Parameter​

ParameterTypeDescription
filePathstringDer Pfad der geprüft werden soll

Rückgabewert​

Promise<boolean>

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1502


getFileInfo()​

static getFileInfo(filePath): FileInfo

Ruft die Dateiinformationen ab

Parameter​

ParameterTypeDescription
filePathstringPfad zur zu prüfenden Datei

Rückgabewert​

FileInfo

Informationen zur angegebenen Datei

Throws​

ArgumentNullException - filePath hat den Wert null.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

ArgumentException - Der Dateiname ist leer, oder er enthält nur Leerräume oder ungültige Zeichen.

Throws​

UnauthorizedAccessException - Der Zugriff auf fileName wird verweigert.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

NotSupportedException - filePath enthält einen Doppelpunkt (:) innerhalb der Zeichenfolge.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2489


getFileInfoAsync()​

static getFileInfoAsync(filePath): Promise<FileInfo>

Ruft die Dateiinformationen ab

Parameter​

ParameterTypeDescription
filePathstringPfad zur zu prüfenden Datei

Rückgabewert​

Promise<FileInfo>

Informationen zur angegebenen Datei

Throws​

ArgumentNullException - filePath hat den Wert null.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

ArgumentException - Der Dateiname ist leer, oder er enthält nur Leerräume oder ungültige Zeichen.

Throws​

UnauthorizedAccessException - Der Zugriff auf fileName wird verweigert.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

NotSupportedException - filePath enthält einen Doppelpunkt (:) innerhalb der Zeichenfolge.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2458


moveAsync()​

static moveAsync(sourceFilePath, destFilePath): Promise<void>

Verschiebt eine vorhandene Datei in eine neue Datei. Das Überschreiben einer gleichnamigen Datei ist unzulässig

Parameter​

ParameterTypeDescription
sourceFilePathstringDie zu verschiebende Datei
destFilePathstringDer Path der Zieldatei. Dabei darf es sich nicht um ein Verzeichnis handeln.

Rückgabewert​

Promise<void>

Throws​

IOException - Die Zieldatei ist bereits vorhanden.

Throws​

ArgumentNullException - sourceFilePath oder destFilePath sind null

Throws​

ArgumentException - sourceFilePath oder destFilePath sind eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - sourceFilePath wurde nicht gefunden.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der in sourceFilePath oder destFilePath angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

NotSupportedException - Das Format von sourceFilePath oder destFilePath ist ungültig.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1428


openAsync()​

static openAsync(filePath): Promise<void>

Öffnet die übergebene Datei mit dem in Windows definierten Standard-Programm.
Sollte kein Standard-Program vorhanden sein, wird die Programmauswahl von Windows angezeigt.

Parameter​

ParameterTypeDescription
filePathstringPfad der zu öffnenden Datei

Rückgabewert​

Promise<void>

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2524


readAllBytesAsync()​

static readAllBytesAsync(filePath): Promise<Uint8Array>

Öffnet eine Binärdatei, liest den Inhalt der Datei in ein Bytearray ein und schließt dann die Datei.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, die zum Lesen geöffnet werden soll.

Rückgabewert​

Promise<Uint8Array>

Ein Bytearray mit dem Inhalt der Datei.

Throws​

ArgumentNullException - filePath ist null

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder filePath ist ein Verzeichnis oder filePath gibt eine schreibgeschützte Datei an.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

OutOfMemoryException - Wenn nicht mehr genug Speicher zur Verfügung steht um das Array zu erstellen.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1569


readAllLinesAsync()​

static readAllLinesAsync(filePath): Promise<string[]>

Öffnet eine Textdatei, liest alle Zeilen der Datei und schließt dann die Datei.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, die zum Lesen geöffnet werden soll.

Rückgabewert​

Promise<string[]>

Ein Zeichenfolgenarray, das alle Zeilen der Datei enthält.

Throws​

ArgumentNullException - filePath ist null

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder filePath ist ein Verzeichnis oder filePath gibt eine schreibgeschützte Datei an.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1695


readAllTextAsync()​

static readAllTextAsync(filePath): Promise<string>

Öffnet eine Textdatei, liest alle Zeilen der Datei und schließt dann die Datei.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, die zum Lesen geöffnet werden soll.

Rückgabewert​

Promise<string>

Eine Zeichenfolge, die alle Zeilen der Datei enthält.

Throws​

ArgumentNullException - filePath ist null

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder filePath ist ein Verzeichnis oder filePath gibt eine schreibgeschützte Datei an.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1632


writeAllBytesAsync()​

static writeAllBytesAsync(filePath, bytes): Promise<void>

Erstellt eine neue Datei, schreibt das angegebene Bytearray in die Datei und schließt die Datei dann.Ist die Zieldatei bereits vorhanden, wird sie überschrieben.

Parameter​

ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
bytesUint8ArrayDie Bytes, die in die Datei geschrieben werden sollen.

Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:2048


writeAllLinesAsync()​

writeAllLinesAsync(filePath, contents)​

static writeAllLinesAsync(filePath, contents): Promise<void>

Erstellt eine neue Datei, schreibt das angegebene Zeichenfolgenarray in die Datei und schließt die Datei dann.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstring[]Das Zeichenfolgenarray, das in die Datei geschrieben werden soll.
Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1947

writeAllLinesAsync(filePath, contents, encoding)​

static writeAllLinesAsync(
filePath,
contents,
encoding): Promise<void>

Erstellt eine neue Datei, schreibt das angegebene Zeichenfolgenarray in die Datei und schließt die Datei dann.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstring[]Das Zeichenfolgenarray, das in die Datei geschrieben werden soll.
encodingstringDie auf die Zeichenfolge anzuwendende Codierung.
Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.
encoding ist kein gültiger Codepagename oder die durch name angegebene Codepage wird von der zugrunde liegenden Plattform nicht unterstützt.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1976


writeAllTextAsync()​

writeAllTextAsync(filePath, contents)​

static writeAllTextAsync(filePath, contents): Promise<void>

Erstellt eine neue Datei, schreibt die angegebene Zeichenfolge mit der angegebenen Codierung in die Datei und schließt die Datei dann. Ist die Zieldatei bereits vorhanden, wird sie überschrieben.
Standardcodierung ist utf-8

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstringDie Zeichenfolge, die in die Datei geschrieben werden soll.
Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1801

writeAllTextAsync(filePath, contents, encoding)​

static writeAllTextAsync(
filePath,
contents,
encoding): Promise<void>

Erstellt eine neue Datei, schreibt die angegebene Zeichenfolge mit der angegebenen Codierung in die Datei und schließt die Datei dann. Ist die Zieldatei bereits vorhanden, wird sie überschrieben.

Parameter​
ParameterTypeDescription
filePathstringDie Datei, in die geschrieben werden soll.
contentsstringDie Zeichenfolge, die in die Datei geschrieben werden soll.
encodingstringDie auf die Zeichenfolge anzuwendende Codierung.
Rückgabewert​

Promise<void>

Throws​

ArgumentException - filePath ist eine Zeichenfolge der Länge 0 oder enthält ein oder mehrere ungültige Zeichen oder geben ein Verzeichnis an.
encoding ist kein gültiger Codepagename oder die durch name angegebene Codepage wird von der zugrunde liegenden Plattform nicht unterstützt.

Throws​

ArgumentNullException - filePath ist null

Throws​

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise müssen Pfade auf Windows-Plattformen weniger als 247 Zeichen und Dateinamen weniger als 259 Zeichen haben.

Throws​

DirectoryNotFoundException - Der angegebene Pfad ist ungültig (z. B. befindet er sich auf einem nicht zugeordneten Laufwerk).

Throws​

IOException - E/A-Fehler beim Öffnen der Datei.

Throws​

UnauthorizedAccessException - filePath gibt eine schreibgeschützte Datei an oder dieser Vorgang wird von der aktuellen Plattform nicht unterstützt oder filePath gibt ein Verzeichnis an oder der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Throws​

FileNotFoundException - Die in filePath angegebene Datei wurde nicht gefunden.

Throws​

NotSupportedException - Das Format von filePath ist ungültig.

Throws​

SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.

Definiert in​

SDK/Cosmolink.Scripting.SDK.FileSystem.ts:1829