abstract File
Enthält eine Funktionssammlung für Datei-Aktionen
Methoden
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
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Die zu kopierende Datei |
destFilePath | string | Der Path der Zieldatei. Dabei darf es sich nicht um ein Verzeichnis handeln. |
overwrite | boolean | true , 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:751
Delete()
static Delete(filePath): Promise<void>
Löscht die angegebene Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Der 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:804
Exists()
static Exists(filePath): Promise<boolean>
Gibt true zurück, wenn die angegebene Datei vorhanden ist, andernfalls false
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Der Pfad der geprüft werden soll |
Rückgabewert
Promise<boolean>
Definiert in
SDK/Cosmolink.Scripting.SDK.FileSystem.ts:815
GetFileInfo()
static GetFileInfo(filePath): Promise<FileInfo>
Ruft die Dateiinformationen ab
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Pfad 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:1106
Move()
static Move(sourceFilePath, destFilePath): Promise<void>
Verschiebt eine vorhandene Datei in eine neue Datei. Das Überschreiben einer gleichnamigen Datei ist unzulässig
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Die zu verschiebende Datei |
destFilePath | string | Der 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:779
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
| Parameter | Type | Description |
|---|---|---|
filePath | string | Pfad 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:1126
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
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die 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:848
ReadAllLines()
static ReadAllLines(filePath): Promise<string[]>
Öffnet eine Textdatei, liest alle Zeilen der Datei und schließt dann die Datei.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die 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:910
ReadAllText()
static ReadAllText(filePath): Promise<string>
Öffnet eine Textdatei, liest alle Zeilen der Datei und schließt dann die Datei.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die 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:879
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
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Datei, in die geschrieben werden soll. |
bytes | Uint8Array | Die 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:1081
WriteAllLines()
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
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Datei, in die geschrieben werden soll. |
contents | string[] | 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:1011
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
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Datei, in die geschrieben werden soll. |
contents | string[] | Das Zeichenfolgenarray, das in die Datei geschrieben werden soll. |
encoding | string | Die 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:1040
WriteAllText()
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
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Datei, in die geschrieben werden soll. |
contents | string | Die 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:941
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
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Datei, in die geschrieben werden soll. |
contents | string | Die Zeichenfolge, die in die Datei geschrieben werden soll. |
encoding | string | Die 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:969