Zum Hauptinhalt springen
Version: 1.24.334.1201

abstract Directory

Enthält eine Funktionssammlung für Verzeichnis-Aktionen

Methoden

Copy()

static Copy(
sourceDirectoryPath,
destDirectoryPath,
overwrite): Promise<void>

Kopiert einen vorhandenen Ordner in einen neuen Order. Das Überschreiben eines gleichnamigen Ordners ist unzulässig

Parameter

ParameterTypeDescription
sourceDirectoryPathstringDer zu kopierende Ordner
destDirectoryPathstringDer Pfad zum Zielordner
overwritebooleantrue , wenn der Zielordner überschrieben werden kann, andernfalls false .

Rückgabewert

Promise<void>

Throws

IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.

Throws

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

Throws

ArgumentException - destDirectoryPath oder destDirectoryPath sind null oder haben die Länge 0

Throws

ArgumentNullException - destDirectoryPath oder destDirectoryPath sind null

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

DirectoryNotFoundException - Der Pfad von destDirectoryPath ist ungültig

Throws

NotSupportedException - sourceDirectoryPath oder destDirectoryPath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.

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:359


CreateDirectory()

static CreateDirectory(destDirectoryPath): Promise<void>

Erstellt einen Ordner

Parameter

ParameterTypeDescription
destDirectoryPathstringDer Pfad zum Zielordner

Rückgabewert

Promise<void>

Throws

IOException - Das durch destDirectoryPath angegebene Verzeichnis ist schreibgeschützt.

Throws

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

Throws

ArgumentException - destDirectoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - destDirectoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Throws

NotSupportedException - destDirectoryPath enthält ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.

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 createDirectoryAsync ersetzt wurde.

Definiert in

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


Delete()

static Delete(directoryPath, recursive): Promise<void>

Löscht die angegebene Datei

Parameter

ParameterTypeDescription
directoryPathstringDer Pfad zum zu löschenden Ordners
recursivebooleantrue zum Entfernen von Verzeichnissen, Unterverzeichnissen und Dateien in directoryPath , andernfalls false .

Rückgabewert

Promise<void>

Throws

IOException - Eine Datei mit dem gleichen Namen und Speicherort (beide mit path angegeben) ist vorhanden oder das durch directoryPath angegebene Verzeichnis ist schreibgeschützt oder recursive ist false und directoryPath ist kein leeres Verzeichnis oder das Verzeichnis ist das aktuelle Arbeitsverzeichnis der Anwendung.

Throws

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder das Verzeichnis enthält eine schreibgeschützte Datei.

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

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:534


Exists()

static Exists(directoryPath): Promise<boolean>

Gibt true zurück, wenn das angegebene Verzeichnis vorhanden ist, andernfalls false

Parameter

ParameterTypeDescription
directoryPathstringDer 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:498


GetDirectories()

Deprecated

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

GetDirectories(directoryPath)

static GetDirectories(directoryPath): Promise<string[]>

Gibt die Pfade der Unterverzeichnisse im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Unterverzeichnisse abgerufen werden sollen.
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Deprecated

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

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Deprecated

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

Definiert in

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

GetDirectories(directoryPath, searchPattern)

static GetDirectories(directoryPath, searchPattern): Promise<string[]>

Gibt die Pfade der Unterverzeichnisse im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Unterverzeichnisse abgerufen werden sollen.
searchPatternstringDie Suchzeichenfolge für die Überprüfung der Namen von Unterverzeichnissen in directoryPath auf Übereinstimmungen. Der Parameter darf nicht zwei Punkte (".."), Verzeichniszeichen oder ungültige Zeichen für Dateinamen enthalten.
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Deprecated

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

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Deprecated

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

Definiert in

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

GetDirectories(directoryPath, searchPattern, allDirectories)

static GetDirectories(
directoryPath,
searchPattern,
allDirectories): Promise<string[]>

Gibt die Pfade der Unterverzeichnisse im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Unterverzeichnisse abgerufen werden sollen.
searchPatternstringDie Suchzeichenfolge für die Überprüfung der Namen von Unterverzeichnissen in directoryPath auf Übereinstimmungen. Der Parameter darf nicht zwei Punkte (".."), Verzeichniszeichen oder ungültige Zeichen für Dateinamen enthalten.
allDirectoriesbooleantrue wenn alle Unterverzeichnise durchsucht werden sollen, andernfalls false Standardwert: false
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Deprecated

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

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Deprecated

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

Definiert in

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


GetFiles()

Deprecated

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

GetFiles(directoryPath)

static GetFiles(directoryPath): Promise<string[]>

Gibt die Pfade der Dateien im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Dateien abgerufen werden sollen.
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Deprecated

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

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Deprecated

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

Definiert in

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

GetFiles(directoryPath, searchPattern)

static GetFiles(directoryPath, searchPattern): Promise<string[]>

Gibt die Pfade der Dateien im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Dateien abgerufen werden sollen.
searchPatternstringDie Suchzeichenfolge für die Überprüfung der Namen von Dateien in directoryPath auf Übereinstimmungen. Der Parameter darf nicht zwei Punkte (".."), Verzeichniszeichen oder ungültige Zeichen für Dateinamen enthalten.
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Deprecated

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

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Deprecated

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

Definiert in

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

GetFiles(directoryPath, searchPattern, allDirectories)

static GetFiles(
directoryPath,
searchPattern,
allDirectories): Promise<string[]>

Gibt die Pfade der Dateien im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Dateien abgerufen werden sollen.
searchPatternstringDie Suchzeichenfolge für die Überprüfung der Namen von Dateien in directoryPath auf Übereinstimmungen. Der Parameter darf nicht zwei Punkte (".."), Verzeichniszeichen oder ungültige Zeichen für Dateinamen enthalten.
allDirectoriesbooleantrue wenn alle Unterverzeichnise durchsucht werden sollen, andernfalls false Standardwert: false
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Deprecated

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

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Deprecated

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

Definiert in

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


GetParent()

static GetParent(path): Promise<string>

Ruft das übergeordnete Verzeichnis des angegebenen Pfads ab, sowohl für absolute als auch für relative Pfade.

Parameter

ParameterTypeDescription
pathstringDer Pfad, dessen übergeordnetes Verzeichnis abgerufen werden soll.

Rückgabewert

Promise<string>

Das übergeordnete Verzeichnis oder null, wenn path das Stammverzeichnis ist, einschließlich des Stammverzeichnisses eines UNC-Server- oder Freigabenamens.

Throws

IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.

Throws

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

Throws

ArgumentException - path ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - path ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Deprecated

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

Definiert in

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


Move()

static Move(sourceDirectoryPath, destDirectoryPath): Promise<void>

Verschiebt einen vorhandenen Ordner in einen neuen Order. Das Überschreiben eines gleichnamigen Ordners ist unzulässig

Parameter

ParameterTypeDescription
sourceDirectoryPathstringDer zu verschiebende Ordner
destDirectoryPathstringDer Pfad zum Zielordner

Rückgabewert

Promise<void>

Throws

IOException - Es wurde versucht, ein Verzeichnis auf einen anderen Volume zu verschieben oder destDirectoryPath ist bereits vorhanden. – oder – Der sourceDirectoryPath und destDirectoryPath verweisen auf dieselbe Datei oder dasselbe Verzeichnis.

Throws

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

Throws

ArgumentException - sourceDirectoryPath oder destDirectoryPath sind eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - sourceDirectoryPath oder destDirectoryPath sind null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

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:411


copyAsync()

static copyAsync(
sourceDirectoryPath,
destDirectoryPath,
overwrite): Promise<void>

Kopiert einen vorhandenen Ordner in einen neuen Order. Das Überschreiben eines gleichnamigen Ordners ist unzulässig

Parameter

ParameterTypeDescription
sourceDirectoryPathstringDer zu kopierende Ordner
destDirectoryPathstringDer Pfad zum Zielordner
overwritebooleantrue , wenn der Zielordner überschrieben werden kann, andernfalls false .

Rückgabewert

Promise<void>

Throws

IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.

Throws

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

Throws

ArgumentException - destDirectoryPath oder destDirectoryPath sind null oder haben die Länge 0

Throws

ArgumentNullException - destDirectoryPath oder destDirectoryPath sind null

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

DirectoryNotFoundException - Der Pfad von destDirectoryPath ist ungültig

Throws

NotSupportedException - sourceDirectoryPath oder destDirectoryPath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.

Definiert in

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


createDirectoryAsync()

static createDirectoryAsync(destDirectoryPath): Promise<void>

Erstellt einen Ordner

Parameter

ParameterTypeDescription
destDirectoryPathstringDer Pfad zum Zielordner

Rückgabewert

Promise<void>

Throws

IOException - Das durch destDirectoryPath angegebene Verzeichnis ist schreibgeschützt.

Throws

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

Throws

ArgumentException - destDirectoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - destDirectoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Throws

NotSupportedException - destDirectoryPath enthält ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.

Definiert in

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


deleteAsync()

static deleteAsync(directoryPath, recursive): Promise<void>

Löscht die angegebene Datei

Parameter

ParameterTypeDescription
directoryPathstringDer Pfad zum zu löschenden Ordners
recursivebooleantrue zum Entfernen von Verzeichnissen, Unterverzeichnissen und Dateien in directoryPath , andernfalls false .

Rückgabewert

Promise<void>

Throws

IOException - Eine Datei mit dem gleichen Namen und Speicherort (beide mit path angegeben) ist vorhanden oder das durch directoryPath angegebene Verzeichnis ist schreibgeschützt oder recursive ist false und directoryPath ist kein leeres Verzeichnis oder das Verzeichnis ist das aktuelle Arbeitsverzeichnis der Anwendung.

Throws

UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung oder das Verzeichnis enthält eine schreibgeschützte Datei.

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Definiert in

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


existsAsync()

static existsAsync(directoryPath): Promise<boolean>

Gibt true zurück, wenn das angegebene Verzeichnis vorhanden ist, andernfalls false

Parameter

ParameterTypeDescription
directoryPathstringDer Pfad der geprüft werden soll

Rückgabewert

Promise<boolean>

Definiert in

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


getDirectoriesAsync()

getDirectoriesAsync(directoryPath)

static getDirectoriesAsync(directoryPath): Promise<string[]>

Gibt die Pfade der Unterverzeichnisse im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Unterverzeichnisse abgerufen werden sollen.
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Definiert in

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

getDirectoriesAsync(directoryPath, searchPattern)

static getDirectoriesAsync(directoryPath, searchPattern): Promise<string[]>

Gibt die Pfade der Unterverzeichnisse im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Unterverzeichnisse abgerufen werden sollen.
searchPatternstringDie Suchzeichenfolge für die Überprüfung der Namen von Unterverzeichnissen in directoryPath auf Übereinstimmungen. Der Parameter darf nicht zwei Punkte (".."), Verzeichniszeichen oder ungültige Zeichen für Dateinamen enthalten.
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Definiert in

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

getDirectoriesAsync(directoryPath, searchPattern, allDirectories)

static getDirectoriesAsync(
directoryPath,
searchPattern,
allDirectories): Promise<string[]>

Gibt die Pfade der Unterverzeichnisse im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Unterverzeichnisse abgerufen werden sollen.
searchPatternstringDie Suchzeichenfolge für die Überprüfung der Namen von Unterverzeichnissen in directoryPath auf Übereinstimmungen. Der Parameter darf nicht zwei Punkte (".."), Verzeichniszeichen oder ungültige Zeichen für Dateinamen enthalten.
allDirectoriesbooleantrue wenn alle Unterverzeichnise durchsucht werden sollen, andernfalls false Standardwert: false
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Definiert in

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


getFilesAsync()

getFilesAsync(directoryPath)

static getFilesAsync(directoryPath): Promise<string[]>

Gibt die Pfade der Dateien im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Dateien abgerufen werden sollen.
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Definiert in

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

getFilesAsync(directoryPath, searchPattern)

static getFilesAsync(directoryPath, searchPattern): Promise<string[]>

Gibt die Pfade der Dateien im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Dateien abgerufen werden sollen.
searchPatternstringDie Suchzeichenfolge für die Überprüfung der Namen von Dateien in directoryPath auf Übereinstimmungen. Der Parameter darf nicht zwei Punkte (".."), Verzeichniszeichen oder ungültige Zeichen für Dateinamen enthalten.
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Definiert in

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

getFilesAsync(directoryPath, searchPattern, allDirectories)

static getFilesAsync(
directoryPath,
searchPattern,
allDirectories): Promise<string[]>

Gibt die Pfade der Dateien im angegebenen Verzeichnis zurück.

Parameter
ParameterTypeDescription
directoryPathstringDas Verzeichnis, aus dem die Dateien abgerufen werden sollen.
searchPatternstringDie Suchzeichenfolge für die Überprüfung der Namen von Dateien in directoryPath auf Übereinstimmungen. Der Parameter darf nicht zwei Punkte (".."), Verzeichniszeichen oder ungültige Zeichen für Dateinamen enthalten.
allDirectoriesbooleantrue wenn alle Unterverzeichnise durchsucht werden sollen, andernfalls false Standardwert: false
Rückgabewert

Promise<string[]>

Ein String-Array von Dateinamen im angegebenen Verzeichnis.

Throws

IOException - directoryPath ist ein Dateiname oder ein Netzwerkfehler ist aufgetreten.

Throws

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

Throws

ArgumentException - directoryPath ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - directoryPath ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Definiert in

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


getParent()

static getParent(path): string

Ruft das übergeordnete Verzeichnis des angegebenen Pfads ab, sowohl für absolute als auch für relative Pfade.

Parameter

ParameterTypeDescription
pathstringDer Pfad, dessen übergeordnetes Verzeichnis abgerufen werden soll.

Rückgabewert

string

Das übergeordnete Verzeichnis oder null, wenn path das Stammverzeichnis ist, einschließlich des Stammverzeichnisses eines UNC-Server- oder Freigabenamens.

Throws

IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.

Throws

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

Throws

ArgumentException - path ist eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - path ist null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Definiert in

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


moveAsync()

static moveAsync(sourceDirectoryPath, destDirectoryPath): Promise<void>

Verschiebt einen vorhandenen Ordner in einen neuen Order. Das Überschreiben eines gleichnamigen Ordners ist unzulässig

Parameter

ParameterTypeDescription
sourceDirectoryPathstringDer zu verschiebende Ordner
destDirectoryPathstringDer Pfad zum Zielordner

Rückgabewert

Promise<void>

Throws

IOException - Es wurde versucht, ein Verzeichnis auf einen anderen Volume zu verschieben oder destDirectoryPath ist bereits vorhanden. – oder – Der sourceDirectoryPath und destDirectoryPath verweisen auf dieselbe Datei oder dasselbe Verzeichnis.

Throws

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

Throws

ArgumentException - sourceDirectoryPath oder destDirectoryPath sind eine Zeichenfolge der Länge 0 (null), besteht nur aus Leerraum oder enthält ein oder mehrere ungültige Zeichen.

Throws

ArgumentNullException - sourceDirectoryPath oder destDirectoryPath sind null.

Throws

PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.

Throws

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

Definiert in

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