Datafox DFCom - API 04.03.22
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
|
#include "df_defines.h"
gehe zum Quellcode dieser Datei
Funktionen | |
int DF_API_CALL | DFCSetupLaden (int connectionNumber, int deviceAddress, const char *filePath, int *errorNumber) |
Schreiben einer Setupdatei (*.aes; *.ael; *.xml). | |
int DF_API_CALL | DFCDownload (int connectionNumber, int deviceAddress, const char *filePath, int *errorNumber) |
Lesen einer Setupdatei (*.aes; *.ael; *.xml). | |
int DF_API_CALL | DFCModifyStudioFile (const char *sourceFilePath, const char *destFilePath, const char *xmlData, int flags, int *errorNumber) |
Verändern von Setupdateien aufgrund einer Vorlagedatei (*.aes; *.ael). | |
int DF_API_CALL | DFCUpload (int connectionNumber, int deviceAddress, const char *filePath, int *errorNumber) |
Schreiben von Gerätedateien (Firmwareupdates) zum Gerät. | |
int DF_API_CALL | DFCFileUpload (int connectionNumber, int deviceAddress, int fileType, const char *filePath, int flags, int *errorNumber) |
Schreiben von Dateidaten zum Gerät. | |
int DF_API_CALL | DFCFileDownload (int connectionNumber, int deviceAddress, int fileType, const char *filePath, int flags, int *errorNumber) |
Lesen von Dateidaten vom Gerät. | |
int DF_API_CALL | DFCUploadModule (int connectionNumber, int deviceAddress, int fileType, const char *filePath, int *errorNumber) |
Schreiben von Modulupdates zum Gerät. | |
DF_API_EXTERN int DF_API_CALL | DFCConvertFile (const char *srcFilePath, int srcType, const char *dstFilePath, int dstType, int flags) |
Konvertieren von Datenformaten auf Dateiebene. | |
DF_API_EXTERN int DF_API_CALL | DFCWriteFile (int connectionNumber, int deviceAddress, int fileType, const char *filePath, const char *routingData, int flags) |
Schreiben von Updatedateien inklusive Routinginformationen zum Gerät übertertragen. | |
DF_API_EXTERN int DF_API_CALL DFCConvertFile | ( | const char * | srcFilePath, |
int | srcType, | ||
const char * | dstFilePath, | ||
int | dstType, | ||
int | flags | ||
) |
Konvertieren von Datenformaten auf Dateiebene.
Das Quell- und Zielformat wird der Konvertierfunktion übergeben. Wenn keine Konvertierungsfunktion verfügbar ist, wird ein entsprechender Fehlerwert zurückgeliefert. Der Inhalt der Zieldatei wird gegebenenfalls gelöscht. Sollte die Zieldatei nicht vorhanden sein, so wird diese erstellt.
DFCConvertFile
DFCConvertFile
[in] | srcFilePath | Der Dateiname (inkl. Pfad) der zu konvertierenden Datei. | ||||||||
[in] | srcType | Typ der Quelldatei [0 für automatische Typerkennung].
| ||||||||
[in] | dstFilePath | Der Dateiname (inkl. Pfad) der zu konvertierenden Datei. | ||||||||
[in] | dstType | Typ der Zieldatei [0 für automatische Typerkennung].
| ||||||||
[in] | flags | Flagfeld zur Steuerung des Konverterergebnisses (zur Zeit nicht verwendet) |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich, Ergebnis wurde in die Datei dstFilePath geschrieben. |
2 | Konvertierung der Formate nicht unterstützt. |
int DF_API_CALL DFCDownload | ( | int | connectionNumber, |
int | deviceAddress, | ||
const char * | filePath, | ||
int * | errorNumber | ||
) |
Lesen einer Setupdatei (*.aes; *.ael; *.xml).
Die im Gerät enthaltene Setupdatei wird ausgelesen und in der angegebenen Datei gespreichert.
_DFCDownload@16
DFCDownload
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | filePath | Dateiname der zu speichernden Setupdatei mit einer der Endungen *.aes oder *.ael. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCFileDownload | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | fileType, | ||
const char * | filePath, | ||
int | flags, | ||
int * | errorNumber | ||
) |
Lesen von Dateidaten vom Gerät.
Liest die Daten der angegebenen Datei unter dem angegebenen Dateinamen aus dem Gerät. Schreiben von Dateidaten erfolgt mit der Funktion DFCFileUpload().
_DFCFileDownload@24
DFCFileDownload
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||||||||
[in] | fileType | Typ der zu lesenden Dateidaten.
| ||||||||||||||
[in] | filePath | Dateiname. | ||||||||||||||
[in] | flags | Reservierter Parameter. Standardwert 0. | ||||||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCFileUpload | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | fileType, | ||
const char * | filePath, | ||
int | flags, | ||
int * | errorNumber | ||
) |
Schreiben von Dateidaten zum Gerät.
Schreibt die Daten der angegebenen Datei unter dem angegebenen Dateinamen in das Gerät. Je nach Dateityp kann diese ggf. später mit DFCFileDownload() wieder ausgelesen werden.
_DFCFileUpload@24
DFCFileUpload
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||||||||
[in] | fileType | Type of file data to be written.
| ||||||||||||||
[in] | filePath | Dateiname. | ||||||||||||||
[in] | flags | Reservierter Parameter. Standardwert 0. | ||||||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCModifyStudioFile | ( | const char * | sourceFilePath, |
const char * | destFilePath, | ||
const char * | xmlData, | ||
int | flags, | ||
int * | errorNumber | ||
) |
Verändern von Setupdateien aufgrund einer Vorlagedatei (*.aes; *.ael).
_DFCModifyStudioFile@20
DFCModifyStudioFile
[in] | sourceFilePath | Dateiname der Setupdatei, die als Template dient. |
[in] | destFilePath | Dateiname der modifizierten Setupdatei, welche dann in das Gerät übertragen werden soll. |
[in] | xmlData | Datenfragment oder Dateiname einer Datei welche die Informationen zum Modifizieren enthält. |
[in] | flags | Reservierter Parameter. Standardwert 0. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCSetupLaden | ( | int | connectionNumber, |
int | deviceAddress, | ||
const char * | filePath, | ||
int * | errorNumber | ||
) |
Schreiben einer Setupdatei (*.aes; *.ael; *.xml).
Die Setupdatei (*.aes; *.ael; *.xml) wird auf das Gerät übertragen. Danach müssen ggf. die Listen neu übertragen werden. Ebenfalls ggf. die Zutrittslisten oder Timeboylisten.
_DFCSetupLaden@16
DFCSetupLaden
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | filePath | Dateiname der zu übertragenden Setupdatei mit einer der Endungen *.aes oder *.ael. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCUpload | ( | int | connectionNumber, |
int | deviceAddress, | ||
const char * | filePath, | ||
int * | errorNumber | ||
) |
Schreiben von Gerätedateien (Firmwareupdates) zum Gerät.
Übertragen der notwendigen Gerätedaten die aus Zeichensatz-, Grafik-, Textdaten sowie Firmware bestehen und zusammen in einer Datei der Endung *.hex oder in einem Archiv der Endung *.dfz vorliegen.
Im Falle eines Firmwareupdates mit Hilfe eines Archivs (*.dfz), in welchem sich eine Updatedatenbank befindet, wird die ermittelte Mindestversion für das zu aktualisierende Gerät in der Logdatei angegeben.
_DFCUpload@16
DFCUpload
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | filePath | Dateiname der Gerätedatei (*.dfz; *.hex). |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCUploadModule | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | fileType, | ||
const char * | filePath, | ||
int * | errorNumber | ||
) |
Schreiben von Modulupdates zum Gerät.
Schreibt die Updatedaten zu verbauten Modulen auf das Gerät. Im Gerät verbaute Module haben teilweise eine eigene updatefähige Firmware. Durch diese Funktion können entsprechende Updatedateien übertragen werden, die dann durch die Gerätefirmware auf die verbauten Module übertragen wird.
_DFCUploadModule@20
DFCUploadModule
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||
[in] | fileType | Typ der zu schreibenden Dateidaten.
| ||||
[in] | filePath | Dateiname. | ||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCWriteFile | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | fileType, | ||
const char * | filePath, | ||
const char * | routingData, | ||
int | flags | ||
) |
Schreiben von Updatedateien inklusive Routinginformationen zum Gerät übertertragen.
Schreibt die Updatedateien zu Geräten, verbauten Modulen und angeschlossenen Modulen auf das Gerät. Durch die zusätzlichen Routinginformationen wird angegeben wohin die Updatedatei verteilt werden soll. Die Rückgabe der Funktion teilt nur die erfolgreiche Übertragung der Updatedaten mit, um zu ermitteln ob die Aktualisierung durchgeführt werden konnte sind entsprechende Systemvariablen oder Feedbackdatensätze zu Lesen.
DFCWriteFile
DFCWriteFile
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||
[in] | fileType | Typ der zu schreibenden Dateidaten.
| ||||
[in] | filePath | Dateiname. | ||||
[in] | routingData | Zusätzliche Routinginformationen für die Updatedatei. | ||||
[in] | flags | Reserviert. Bitte 0 als Wert übergeben. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |