df_files.h-Dateireferenz

#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.

Dokumentation der Funktionen

DFCConvertFile()

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.

Export

DFComDLL als DFCConvertFile
DFCom_x64 als DFCConvertFile

Parameter

[in]	srcFilePath	Der Dateiname (inkl. Pfad) der zu konvertierenden Datei.
[in]	srcType	Typ der Quelldatei [0 für automatische Typerkennung]. Typ Wert auto detection 0 AES/AEL 1 XML 2
[in]	dstFilePath	Der Dateiname (inkl. Pfad) der zu konvertierenden Datei.
[in]	dstType	Typ der Zieldatei [0 für automatische Typerkennung]. Dateityp Wert auto detection 0 AES/AEL 1 XML 2
[in]	flags	Flagfeld zur Steuerung des Konverterergebnisses (zur Zeit nicht verwendet)

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich, Ergebnis wurde in die Datei dstFilePath geschrieben.
2	Konvertierung der Formate nicht unterstützt.

Seit

04.03.14.06 enthalten.

DFCDownload()

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.

Export

DFComDLL als _DFCDownload@16
DFCom_x64 als DFCDownload

Warnung

Eine ggf. vorhandene Datei kann durch die auszulesende überschrieben werden.

Parameter

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit

04.03.14.06 werden Konfigurationsdateien im XML-Format unterstützt.

DFCFileDownload()

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().

Export

DFComDLL als _DFCFileDownload@24
DFCom_x64 als DFCFileDownload

Siehe auch

Zusätzliche Hinweise zur Funktion finden Sie im Kapitel Auslesen von Datendateien (Kamerabilder, Unterschriftbilder, Barcodedaten, etc.).

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[in]	fileType	Typ der zu lesenden Dateidaten. Wert Bedeutung -1 Dateityp wird an der Namensendung (*.dfl, *.dfk, *.dfc, *.df0) erkannt. Andere Dateiendungen werden nicht unterstützt. 0 Nur Schreiben möglich. Datei mit Textdaten der Firmware. Endung *.dfl 1 Nur Schreiben möglich. Datei mit Touchtastendefinitionen des Touch. Endung *.dfk 2 Nur Schreiben möglich. Datei mit Farbeinstellungen für TimeboyIV. Endung *.dfc 3 Datei mit LAN / WLAN Konfigurationsdaten. Endung *.df0 4 Dateiangabe. Endung (*.*)
[in]	filePath	Dateiname.
[in]	flags	Reservierter Parameter. Standardwert 0.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

DFCFileUpload()

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.

Export

DFComDLL als _DFCFileUpload@24
DFCom_x64 als DFCFileUpload

Zu beachten

Diese Funktion ist nicht dafür gedacht Anwenderdateien auf dem Gerät abzulegen. Unbekannte Dateien werden bei Bedarf von der Firmware gelöscht. Ggf. kann es durch eine Unsachgemäße Verwendung zu Problemen bei der Übernahme von Listendaten u. a. kommen.

Siehe auch

Zusätzliche Hinweise zur Funktion finden Sie im Kapitel Nutzung von Konfigurationsdateien. ((W)LAN-Konfiguration, Display-Design, etc.).

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[in]	fileType	Type of file data to be written. Wert Bedeutung -1 Dateityp wird an der Namensendung (*.dfl, *.dfk, *.dfc, *.df0) erkannt. Andere Dateiendungen werden nicht unterstützt. 0 Datei mit Textdaten der Firmware. Endung *.dfl 1 Datei mit Touchtastendefinitionen des Touch. Endung *.dfk 2 Datei mit Farbeinstellungen für TimeboyIV. Endung *.dfc 3 Datei mit LAN / WLAN Konfigurationsdaten. Endung *.df0 4 Dateiangabe. Endung (*.*)
[in]	filePath	Dateiname.
[in]	flags	Reservierter Parameter. Standardwert 0.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

DFCModifyStudioFile()

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).

Export

DFComDLL als _DFCModifyStudioFile@20
DFCom_x64 als DFCModifyStudioFile

Zu beachten

Zur Funktion liegt ein eigenes Dokument auf der Produkt-DVD.

Parameter

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Beispiel für xmlData.

<?xml version="1.0" ?>
<modify>
    <password>
      <system>
          <value>1234</value>
      </system>
      <user>
          <value>2345</value>
      </user>
      <menu_item>
          <name>MEID_003</name>
          <value>4711</value>
      </menu_item>
  </password>
 
  <fingerprint>
      <security_level>20</security_level>
      <image_quality>70</image_quality>
      <minutiae_count>20</minutiae_count>
  </fingerprint>
 
  <replace>
      <name>
          <search>MID_001</search>
          <replacement>PZE Setup</replacement>
      </name>
      <name>
          <search>MEID_001</search>
          <replacement>Kommt:</replacement>
      </name>
      <name>
          <search>MEID_002</search>
          <replacement>Geht:</replacement>
      </name>
      <name>
          <search>MEID_003</search>
          <replacement>Abwesend</replacement>
      </name>
  </replace>
</modify>

DFCSetupLaden()

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.

Zu beachten

Es dürfen sich keine abrufbare Datensätze mehr auf dem Gerät befinden. Rufen Sie diese zuvor mit DFCReadRecord() ab oder wenn sie nicht mehr benötigt werden, dann können Sie diese mit DFCComClearData() löschen.

Export

DFComDLL als _DFCSetupLaden@16
DFCom_x64 als DFCSetupLaden

Parameter

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit

04.03.14.06 werden Konfigurationsdateien im XML-Format unterstützt.

DFCUpload()

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.

Export

DFComDLL als _DFCUpload@16
DFCom_x64 als DFCUpload

Zu beachten

Unter Unix-Systemen ist bei Verwendung eines Archives *.dfz dieses vor der Übertragung zu entpacken und beim Aufruf der Funktion das Verzeichnis anzugeben.

Parameter

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

DFCUploadModule()

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.

Export

DFComDLL als _DFCUploadModule@20
DFCom_x64 als DFCUploadModule

Zu beachten

Ein Updatevorgang kann durch Verwendung von DFCGetInfo() überprüft werden.

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[in]	fileType	Typ der zu schreibenden Dateidaten. Wert Bedeutung 0 Firmwareupdate für Biokey von Idencom. Endungen *.up3, *.up4, *.up5
[in]	filePath	Dateiname.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

DFCWriteFile()

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.

Export

DFComDLL als DFCWriteFile
DFCom_x64 als DFCWriteFile

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[in]	fileType	Typ der zu schreibenden Dateidaten. Wert Bedeutung 0 IFF-Updatedatei. Endung *.iff
[in]	filePath	Dateiname.
[in]	routingData	Zusätzliche Routinginformationen für die Updatedatei.
[in]	flags	Reserviert. Bitte 0 als Wert übergeben.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit

04.03.20 enthalten.