abstract Path
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2930
Enthält eine Funktionssammlung für Pfad-Aktionen
Methoden
combine()
static combine(...paths): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2973
Kombiniert ein Array von Zeichenfolgen zu einen Pfad
Parameter
| Parameter | Type | Description |
|---|---|---|
...paths | string[] | Erforderlich. Beliebig viele Teilbereiche eines Pfades |
Rückgabewert
string
Throws
ArgumentException - Eine der Zeichenfolgen im Array enthält ein oder mehrere ungültigen Zeichen.
Throws
ArgumentNullException - Eine der Zeichenfolgen im Array ist null.
Combine()
static Combine(...paths): Promise<string>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2959
Kombiniert ein Array von Zeichenfolgen zu einen Pfad
Parameter
| Parameter | Type | Description |
|---|---|---|
...paths | string[] | Erforderlich. Beliebig viele Teilbereiche eines Pfades |
Rückgabewert
Promise<string>
Throws
ArgumentException - Eine der Zeichenfolgen im Array enthält ein oder mehrere ungültigen Zeichen.
Throws
ArgumentNullException - Eine der Zeichenfolgen im Array ist null.
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 combine ersetzt wurde.
getExtension()
static getExtension(filePath): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3002
Gibt die Erweiterung der angegebenen Pfadzeichenfolge zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Pfadzeichenfolge, aus der die Erweiterung abgerufen werden soll. |
Rückgabewert
string
Gibt die Dateierweiterung einschließlich "." zurück.
Throws
ArgumentException
- filePath enthält ein oder mehrere ungültigen Zeichen.
GetExtension()
static GetExtension(filePath): Promise<string>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2988
Gibt die Erweiterung der angegebenen Pfadzeichenfolge zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Pfadzeichenfolge, aus der die Erweiterung abgerufen werden soll. |
Rückgabewert
Promise<string>
Gibt die Dateierweiterung einschließlich "." zurück.
Throws
ArgumentException
- filePath enthält ein oder mehrere ungültigen Zeichen.
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 getExtension ersetzt wurde.
getFileName()
static getFileName(filePath): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3060
Gibt den Dateinamen und die Erweiterung der angegebenen Pfadzeichenfolge zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Pfadzeichenfolge, aus welche der Dateiname und die Erweiterung abgerufen werden sollen. |
Rückgabewert
string
Gibt den Dateinamen inklusive Dateierweiterung zurück
Throws
ArgumentException
- filePath enthält ein oder mehrere ungültigen Zeichen.
GetFileName()
static GetFileName(filePath): Promise<string>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3046
Gibt den Dateinamen und die Erweiterung der angegebenen Pfadzeichenfolge zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Pfadzeichenfolge, aus welche der Dateiname und die Erweiterung abgerufen werden sollen. |
Rückgabewert
Promise<string>
Gibt den Dateinamen inklusive Dateierweiterung zurück
Throws
ArgumentException
- filePath enthält ein oder mehrere ungültigen Zeichen.
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 getFileName ersetzt wurde.
getFileNameWithoutExtension()
static getFileNameWithoutExtension(filePath): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3031
Gibt den Dateinamen der angegebenen Pfadzeichenfolge ohne Erweiterung zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Der Pfad der Datei. |
Rückgabewert
string
Gibt den Dateinamen ohne Dateierweiterung zurück
Throws
ArgumentException
- filePath enthält ein oder mehrere ungültigen Zeichen.
GetFileNameWithoutExtension()
static GetFileNameWithoutExtension(filePath): Promise<string>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3017
Gibt den Dateinamen der angegebenen Pfadzeichenfolge ohne Erweiterung zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Der Pfad der Datei. |
Rückgabewert
Promise<string>
Gibt den Dateinamen ohne Dateierweiterung zurück
Throws
ArgumentException
- filePath enthält ein oder mehrere ungültigen Zeichen.
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 getFileNameWithoutExtension ersetzt wurde.
getFullPath()
Aufrufsignatur
static getFullPath(path): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3162
Gibt den absoluten Pfad für die angegebene Pfadzeichenfolge zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
path | string | Die Datei oder das Verzeichnis, für das die absoluten Pfadinformationen abgerufen werden sollen. |
Rückgabewert
string
Der vollqualifizierte Speicherort von path, z. B. "C:\MyFile.txt".
Aufrufsignatur
static getFullPath(path, basePath): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3172
Gibt einen absoluten Pfad aus einem relativen Pfad und einen vollqualifizierten Basispfad zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
path | string | Ein relativer Pfad zum Verketten mit basePath. |
basePath | string | Der Anfang eines vollqualifizierten Pfads. |
Rückgabewert
string
Der absolute Pfad.
getTempFileName()
static getTempFileName(): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3114
Erstellt eine eindeutig benannte temporäre Datei auf dem Datenträger mit einer Größe von 0 Byte und gibt den vollständigen Pfad dieser Datei zurück.
Rückgabewert
string
Gibt den Pfad der temporären Datei zurück.
Throws
IOException - Ein E/A-Fehler tritt auf, z.B. ist kein eindeutiger temporärer Dateiname verfügbar oder diese Methode konnte keine temporäre Datei erstellen.
GetTempFileName()
static GetTempFileName(): Promise<string>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3101
Erstellt eine eindeutig benannte temporäre Datei auf dem Datenträger mit einer Größe von 0 Byte und gibt den vollständigen Pfad dieser Datei zurück.
Rückgabewert
Promise<string>
Gibt den Pfad der temporären Datei zurück.
Throws
IOException - Ein E/A-Fehler tritt auf, z.B. ist kein eindeutiger temporärer Dateiname verfügbar oder diese Methode konnte keine temporäre Datei 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 synchrone Funktion getTempFileName ersetzt wurde.
getTempPath()
static getTempPath(): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3087
Gibt den Pfad des temporären Ordners des aktuellen Systems zurück.
Rückgabewert
string
Gibt den Pfad eines temporären Verzeichnisses zurück.
Throws
SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung für diesen Vorgang.
GetTempPath()
static GetTempPath(): Promise<string>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3074
Gibt den Pfad des temporären Ordners des aktuellen Systems zurück.
Rückgabewert
Promise<string>
Gibt den Pfad eines temporären Verzeichnisses zurück.
Throws
SecurityException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung für diesen Vorgang.
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 getTempPath ersetzt wurde.
replaceInvalidFileNameChars()
static replaceInvalidFileNameChars(fileName, replaceValue?): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3143
Ersetzt alle ungültigen Zeichen in einem Dateinamen durch den angegebenen Wert.
Parameter
| Parameter | Type | Description |
|---|---|---|
fileName | string | Der Dateiname bei dem alle ungültigen Zeichen ersetzt werden sollen. |
replaceValue? | string | Optional: Der Ersetzungswert. Wird kein Wert angegeben, werden ungültige Zeichen einfach entfernt. |
Rückgabewert
string
replaceInvalidPathChars()
static replaceInvalidPathChars(path, replaceValue?): string;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3125
Ersetzt alle ungültigen Zeichen in einem Verzeichnispfad durch den angegebenen Wert.
Parameter
| Parameter | Type | Description |
|---|---|---|
path | string | Der Dateipfad bei dem alle ungültigen Zeichen ersetzt werden sollen. |
replaceValue? | string | Optional: Der Ersetzungswert. Wird kein Wert angegeben, werden ungültige Zeichen einfach entfernt. |
Rückgabewert
string