import { Callout } from "zudoku/ui/Callout";

# Datei-Plugin

Das **File Plugin** der 365 business Proxy Application ermöglicht den vollumfänglichen Zugriff auf lokale Dateisysteme, Netzlaufwerke und UNC-Pfade.

Es gehört zu den **Standard-Plugins** und kann direkt über die Seite **Proxy Application Clients** in Microsoft Dynamics 365 Business Central installiert werden.

---

## AL-Integration

Alle Funktionen werden über die Codeunit `bdev.PRX Proxy Application` (ID 5523630) bereitgestellt.

### Beispiel

Im folgenden Beispiel wird ein Ordner eingelesen, eine vorhandene Datei ggf. gelöscht und eine neue Datei mit dem Inhalt `"Hello, World!"` erstellt:

```pascal

procedure ExampleFilePlugin
var
  files: Record "bdev.PRX File Item" temporary;
  proxyApp: Codeunit "bdev.PRX Proxy Application";
begin
  // get file list for directory "C:\temp"
  proxyApp.ListFiles(
    files,
    'C:\temp'
  );

  // check whether "hello-world.txt" exists
  files.Reset();
  files.SetRange("Name", 'hello-world.txt');
  files.SetRange("Is File", true);
  if (files.FindFirst()) then
    // if file exists, delete it
    proxyApp.DeleteFile(files."File Path");

  // create file "hello-world.txt"
  proxyApp.PostFile(
    'C:\temp\hello-world.txt',
    GetFileWithContent('Hello, World!')
  );  
end;

local procedure GetFileWithContent(content: Text) file: Codeunit "Temp Blob"
var
  stream: OutStream;
begin
  file.CreateOutStream(stream, TextEncoding::UTF8);
  stream.WriteText(content);

  exit(file);
end;

```

---

## Funktionen im Überblick

### Dateien auflisten – (*ListFiles*)

```pascal
files: Record "bdev.PRX File Item" temporary := ListFiles([clientId: Guid,] filePath: Text [,fileFilter: Text])
```

```pascal
ListFiles(var files: Record "bdev.PRX File Item" temporary, [clientId: Guid,] filePath: Text [,fileFilter: Text])
```

**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `filePath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad an, für den die Dateiliste abgerufen werden soll.
 - `fileFilter: Text`<br/>
   Gibt den Filter (z.B. `*.txt`) an, der bei der Auflistung angewandt werden soll.

**Rückgabe**

Gibt die temporäre Tabelle `bdev.PRX File Item` zu, die die Dateiliste darstellt.

---

### Prüfen ob Datei existiert (*FileExists*)

```pascal
fileExists: Boolean := FileExists([clientId: Guid,] filePath: Text)
```

**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `filePath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad der Datei an.

**Rückgabe**

Gibt `true` zurück, wenn die Datei existiert.

---

### Datei lesen (*GetFile*)

```pascal
file: Codeunit "Temp Blob" := GetFile([clientId: Guid,] filePath: Text)
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `filePath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad der Datei an.

**Rückgabe**

Gibt `Codeunit "Temp Blob"` zurück, mit dem Inhalt der Datei.

---

### Datei schreiben (*PostFile*)

<Callout type="danger" title="Achtung">
Bitte beachten Sie, dass das Limit der Dateigröße bei 250 MB liegt.
</Callout>

```pascal
success: Boolean := PostFile([clientId: Guid,] filePath: Text, file: Codeunit "Temp Blob")
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `filePath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad der Datei an.
 - `file: Codeunit "Temp Blob"`<br/>
   Die Datei die geschrieben werden soll.

**Rückgabe**

Gibt `true` zurück, wenn die Datei erfolgreich geschrieben wurde.

---

### Datei löschen (*DeleteFile*)

```pascal
success: Boolean := DeleteFile([clientId: Guid,] filePath: Text)
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `filePath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad der Datei an.

**Rückgabe**

Gibt `true` zurück, wenn die Datei erfolgreich gelöscht wurde.

---

### Datei verschieben (*MoveFile*)

```pascal
success: Boolean := MoveFile([clientId: Guid,] fromFilePath: Text, toFilePath: Text [, overwrite: Boolean])
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `fromFilePath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad der Datei an, die verschoben werden soll.
 - `toFilePath: Text`<br/>
   Gibt den Zielpfad oder UNC-Pfad an, zu dem die Datei verschoben werden soll.
 - `overwrite: Boolean`<br/>
   Gibt an, ob die Datei am Ziel überschrieben werden soll, falls sie bereits existiert.

**Rückgabe**

Gibt `true` zurück, wenn die Datei erfolgreich verschoben wurde.

---

### Datei kopieren (*CopyFile*)

```pascal
success: Boolean := CopyFile([clientId: Guid,] fromFilePath: Text, toFilePath: Text [, overwrite: Boolean])
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `fromFilePath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad der Datei an, die kopiert werden soll.
 - `toFilePath: Text`<br/>
   Gibt den Zielpfad oder UNC-Pfad an, zu dem die Datei kopiert werden soll.
 - `overwrite: Boolean`<br/>
   Gibt an, ob die Datei am Ziel überschrieben werden soll, falls sie bereits existiert.

**Rückgabe**

Gibt `true` zurück, wenn die Datei erfolgreich kopiert wurde.

---

### Datei umbenennen (*RenameFile*)

```pascal
success: Boolean := RenameFile([clientId: Guid,] filePath: Text, newFilePath: Text)
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `filePath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad der Datei an.
 - `newFilePath: Text`<br/>
   Gibt den neuen Namen und Pfad der Datei an.

**Rückgabe**

Gibt `true` zurück, wenn die Datei erfolgreich umbenannt wurde.

---

### Prüfen ob Verzeichnis existiert (*DirectoryExists*)

```pascal
success: Boolean := DirectoryExists([clientId: Guid,] directoryPath: Text)
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `directoryPath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad des Verzeichnis an.

**Rückgabe**

Gibt `true` zurück, wenn das Verzeichnis existiert.

---

### Verzeichnis erstellen (*CreateDirectory*)

```pascal
success: Boolean := CreateDirectory([clientId: Guid,] directoryPath: Text)
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `directoryPath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad des Verzeichnis an, das erstellt werden soll.

**Rückgabe**

Gibt `true` zurück, wenn das Verzeichnis erstellt wurde.

---

### Verzeichnis löschen (*DeleteDirectory*)

```pascal
success: Boolean := DeleteDirectory([clientId: Guid,] directoryPath: Text [, recursive: Boolean])
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `directoryPath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad des Verzeichnis an, das gelöscht werden soll.
 - `recursive: Boolean`<br/>
   Gibt an, ob das Verzeichnis rekursiv gelöscht werden soll.

**Rückgabe**

Gibt `true` zurück, wenn das Verzeichnis gelöscht wurde.

---

### Verzeichnis verschieben (*MoveDirectory*)

```pascal
success: Boolean := MoveDirectory([clientId: Guid,] fromDirectoryPath: Text, toDirectoryPath: Text)
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `fromDirectoryPath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad des Verzeichnis an, das verschoben werden soll.
 - `toDirectoryPath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad an, zu dem das Verzeichnis verschoben werden soll.

**Rückgabe**

Gibt `true` zurück, wenn das Verzeichnis verschoben wurde.

---

### Verzeichnis kopieren (*CopyDirectory*)

```pascal
success: Boolean := CopyDirectory([clientId: Guid,] fromDirectoryPath: Text, toDirectoryPath: Text)
```
**Parameter**

 - `clientId: Guid` (Optional)<br/>
   Gibt die ID des Proxy Application Client an, auf dem die Operation ausgeführt werden soll.
 - `fromDirectoryPath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad des Verzeichnis an, das kopiert werden soll.
 - `toDirectoryPath: Text`<br/>
   Gibt den Pfad oder UNC-Pfad an, zu dem das Verzeichnis kopiert werden soll.

**Rückgabe**

Gibt `true` zurück, wenn das Verzeichnis kopiert wurde.