df_setup_records.h-Dateireferenz

#include "df_defines.h"

gehe zum Quellcode dieser Datei

Funktionen
int DF_API_CALL	DFCComClearData (int connectionNumber, int deviceAddress)
	Datensätze löschen.
int DF_API_CALL	DFCComCollectData (int connectionNumber, int deviceAddress, int *errorNumber)
	Datensätze aus Gerät lesen.
int DF_API_CALL	DFCComGetDatensatz (int connectionNumber, unsigned char *buffer, int *bufferSize, int *errorNumber)
	Datensatz aus Bibliothekspuffer lesen.
int DF_API_CALL	DFCLoadDatensatzbeschreibung (int connectionNumber, int deviceAddress, int *errorNumber)
	Aufbau der Datensatztabellen aus dem Geräte lesen.
int DF_API_CALL	DFCDatBCnt (int connectionNumber)
	Anzahl der gelesenen Datensatztabellen abrufen.
int DF_API_CALL	DFCDatBDatensatz (int connectionNumber, int number, char *name, int *fieldCount)
	Grunddaten einer Datensatztabelle abrufen.
int DF_API_CALL	DFCDatBFeld (int connectionNumber, int datBNumber, int number, char *name, int *type, int *size)
	Grunddaten eines Datensatzfeldes abrufen.
int DF_API_CALL	DFCReadRecord (int connectionNumber, int deviceAddress, unsigned char *buffer, int *bufferSize, int *errorNumber)
	Datensatz aus Gerät lesen.
int DF_API_CALL	DFCQuitRecord (int connectionNumber, int deviceAddress, int *errorNumber)
	Datensatz im Gerät quittieren.
int DF_API_CALL	DFCRestoreRecords (int connectionNumber, int deviceAddress, int *errorNumber)
	Datensätze wiederherstellen.
DF_API_EXTERN int DF_API_CALL	DFCQuitRecordExt (int connectionNumber, int deviceAddress, char *param, int *paramLength)
	Datensatz im Gerät quittieren.

Dokumentation der Funktionen

DFCComClearData()

int DF_API_CALL DFCComClearData	(	int	connectionNumber,
		int	deviceAddress
	)

Datensätze löschen.

Bei den verwendeten Ringspeichern werden die Datenzeiger zurückgesetzt. Die im Gerät eventuell enthaltenen Datensätze werden dadurch unwiederruflich gelöscht.

Export

DFComDLL als _DFCComClearData@8
DFCom_x64 als DFCComClearData

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.

Rückgabewerte

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

DFCComCollectData()

int DF_API_CALL DFCComCollectData	(	int	connectionNumber,
		int	deviceAddress,
		int *	errorNumber
	)

Datensätze aus Gerät lesen.

Es wird ein Datensatz aus dem Gerät ausgelesen und in einem Bibliothekspuffer zwischengespeichert. Zum weiteren Abruf der Datensätze wird die Funktion DFCComGetDatensatz() verwendet.

Export

DFComDLL als _DFCComCollectData@12
DFCom_x64 als DFCComCollectData

Veraltet:

Bitte verwenden Sie die Funktionen DFCReadRecord() und DFCQuitRecord() zum Auslesen der Datensätze.

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

-1	Fehler bei Ausführung.
0	Keine Datensätze vorhanden.
1	Es wurde ein Offline-Datensatz gelesen.
2	Es wurde ein Online-Datensatz gelesen.

DFCComGetDatensatz()

int DF_API_CALL DFCComGetDatensatz	(	int	connectionNumber,
		unsigned char *	buffer,
		int *	bufferSize,
		int *	errorNumber
	)

Datensatz aus Bibliothekspuffer lesen.

Es wird ein Datensatz aus dem Bibliothekspuffer übernommen und ggf. ein weiterer aus dem Gerät gelesen. Die Geräteadresse ist durch vorherigen Aufruf der Funktion DFCComCollectData() bekannt, diese muss einmalig aufgerufen worden sein um mit DFCComGetDatensatz Datensätze abrufen zu können.

Export

DFComDLL als _DFCComGetDatensatz@16
DFCom_x64 als DFCComGetDatensatz

Veraltet:

Bitte verwenden Sie die Funktionen DFCReadRecord() und DFCQuitRecord() zum Auslesen der Datensätze.

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[out]	buffer	Datenpuffer.
[in,out]	bufferSize	Als [in] die reservierte Größe von buffer (mindestens 242 Byte), als [out] die übergebene Datensatzlänge.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

-1	Fehler bei Ausführung.
0	Keine weiteren Datensätze vorhanden.
1	Es wurde ein Offline-Datensatz übergeben.
2	Es wurde ein Online-Datensatz übergeben. Auch letzter Datensatz.

DFCDatBCnt()

int DF_API_CALL DFCDatBCnt

(

int

connectionNumber

)

Anzahl der gelesenen Datensatztabellen abrufen.

Auf Grundlage der zuvor mit DFCLoadDatensatzbeschreibung() gelesenen Datensatztabellen, wird die im Gerätesetup definierte Anzahl zurückgegeben.

Export

DFComDLL als _DFCDatBCnt@4
DFCom_x64 als DFCDatBCnt

Parameter

[in]

connectionNumber

Zu verwendende Verbindungsnummer.

Rückgabe

Anzahl der Datensatztabellen.

DFCDatBDatensatz()

int DF_API_CALL DFCDatBDatensatz	(	int	connectionNumber,
		int	number,
		char *	name,
		int *	fieldCount
	)

Grunddaten einer Datensatztabelle abrufen.

Auf Grundlage der zuvor mit DFCLoadDatensatzbeschreibung() gelesenen Datensatztabellen, werden die Grunddaten zu einer Datensatztabelle zurückgegeben.

Export

DFComDLL als _DFCDatBDatensatz@16
DFCom_x64 als DFCDatBDatensatz

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	number	Datensatznummer. Bereich 0 bis DFCDatBCnt() - 1
[out]	name	Zeichenpuffer für den Namen. Muss mindestens 17 Zeichen lang sein.
[out]	fieldCount	Anzahl der Felder.

Rückgabewerte

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

DFCDatBFeld()

int DF_API_CALL DFCDatBFeld	(	int	connectionNumber,
		int	datBNumber,
		int	number,
		char *	name,
		int *	type,
		int *	size
	)

Grunddaten eines Datensatzfeldes abrufen.

Auf Grundlage der zuvor mit DFCLoadDatensatzbeschreibung() gelesenen Datensatztabellen, werden die Grunddaten zu einem Datensatzfeld zurückgegeben.

Export

DFComDLL als _DFCDatBFeld@24
DFCom_x64 als DFCDatBFeld

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	datBNumber	Datensatznummer. Bereich 0 bis DFCDatBCnt() - 1.
[in]	number	Feldnummer. Bereich 0 bis maximal 25.
[out]	name	Zeichenpuffer für den Feldnamen. Muss mindestens 17 Zeichen lang sein.
[out]	type	Datentyp. Wert Bedeutung 1 uint32 (4 Byte) 2 DateTime (7 Byte, 4 Byte Date, 3 Byte Time) 3 String (1-41 Byte, only digits [0-9]) 4 String (1-41 Byte, Latin1 codec) 5 Date (4 Byte; Y100, Y, M, D) 6 Time (3 Byte; h, m, s) 7 Finger template (161 Byte; DIN V66400) 8 Finger template (216 Byte; Idencom Compact) 9 Binar data (1-220 Byte, Binär) 10 Daten (2-241 Byte, Binär)
[out]	size	Länge. Die Längenangabe beinhaltet ein eventuell benötigtes Nullterminierungszeichen bei Feldern für Zeichenfolgen.

Rückgabewerte

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

DFCLoadDatensatzbeschreibung()

int DF_API_CALL DFCLoadDatensatzbeschreibung	(	int	connectionNumber,
		int	deviceAddress,
		int *	errorNumber
	)

Aufbau der Datensatztabellen aus dem Geräte lesen.

Es werden die im Gerätesetup verwendeten Tabellenbeschreibungen für die Datensätze in den Bibliotheksinternen Puffer gelesen. Hiernach kann mit den Funktionen DFCDatBCnt(), DFCDatBDatensatz() und DFCDatBFeld() auf die ermittelten Daten zugegriffen werden.

Export

DFComDLL als _DFCLoadDatensatzbeschreibung@12
DFCom_x64 als DFCLoadDatensatzbeschreibung

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

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

DFCQuitRecord()

int DF_API_CALL DFCQuitRecord	(	int	connectionNumber,
		int	deviceAddress,
		int *	errorNumber
	)

Datensatz im Gerät quittieren.

Es wird versucht einen zuvor mit DFCReadRecord() gelesenen Datensatz zu quittieren. Nach erfolgreicher Quittierung kann mit einem folgenden Aufruf von DFCReadRecord der ggf. nächste Datensatz gelesen werden.

Export

DFComDLL als _DFCQuitRecord@12
DFCom_x64 als DFCQuitRecord

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

-1	Fehler bei Ausführung.
0	Keine Quittung benötigt.
1	Online-Datensatz quittiert.
2	Wiederholt einen Online-Datensatz quittiert.
3	Offline-Datensatz quittiert.
4	Wiederholt einen Offline-Datensatz quittiert.

DFCQuitRecordExt()

DF_API_EXTERN int DF_API_CALL DFCQuitRecordExt	(	int	connectionNumber,
		int	deviceAddress,
		char *	param,
		int *	paramLength
	)

Datensatz im Gerät quittieren.

Es wird versucht einen zuvor mit DFCReadRecord() gelesenen Datensatz zu quittieren. Nach erfolgreicher Quittierung kann mit einem folgenden Aufruf von DFCReadRecord der ggf. nächste Datensatz gelesen werden.

Export

DFComDLL als DFCQuitRecordExt
DFCom_x64 als DFCQuitRecordExt

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[in,out]	param	Zeichenfolge als Parameterstring. Wird 1:1 an die Firmware weitergereicht. Die aktuelle Detailbeschreibung finden Sie im Softwarebegleitheft zur Version 04.03.12.
[in,out]	paramLength	Als in die Länge des auf param verweisenden Puffers, als out die nach param kopierte Länge des Antwortparameters.

Rückgabewerte

-1	Fehler bei Ausführung.
0	Keine Quittung benötigt.
1	Online-Datensatz quittiert.
2	Wiederholt einen Online-Datensatz quittiert.
3	Offline-Datensatz quittiert.
4	Wiederholt einen Offline-Datensatz quittiert.

Seit

04.03.12 enthalten.

DFCReadRecord()

int DF_API_CALL DFCReadRecord	(	int	connectionNumber,
		int	deviceAddress,
		unsigned char *	buffer,
		int *	bufferSize,
		int *	errorNumber
	)

Datensatz aus Gerät lesen.

Es wird versucht einen Datensatz aus dem Gerät zu lesen. Nach erfolgreicher Vararbeitung muss dieser mit DFCQuitRecord() quittiert werden, damit weitere Datensätze abgerufen werden können. Wird ein Datensatz nicht mit DFCQuitRecord quittiert wird er als ein Wiederholt gelieferter Datensatz gemeldet.

Export

DFComDLL als _DFCReadRecord@20
DFCom_x64 als DFCReadRecord

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[out]	buffer	Datenpuffer.
[in,out]	bufferSize	Als [in] die reservierte Größe von buffer (mindestens 242 Byte), als [out] die übergebene Datensatzlänge.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

-1	Fehler bei Ausführung.
0	Keine Datensätze vorhanden.
1	Online-Datensatz gelesen.
2	Wiederholt ein Online-Datensatz gelesen.
3	Offline-Datensatz gelesen.
4	Wiederholt ein Offline-Datensatz gelesen.

DFCRestoreRecords()

int DF_API_CALL DFCRestoreRecords	(	int	connectionNumber,
		int	deviceAddress,
		int *	errorNumber
	)

Datensätze wiederherstellen.

Durch ein Zurücksetzen der Datensatzzeiger auf den letzten auslesbaren Datensatz wird ein Wiederauslesen über DFCReadRecord() möglich. Durch Verwendung eines Ringspeichers in den Geräten werden ggf. ältere Datensätze durch aktuellere überschrieben.

Export

DFComDLL als _DFCRestoreRecords@12
DFCom_x64 als DFCRestoreRecords

Warnung

Durch ein Wiederherstellen der Datensätze kann eine ggf. sehr große Datensatzmenge entstehen.

Zu beachten

Durch Aufruf von DFCComClearData() oder DFCSetupLaden() werden die Datensätze gelöscht. Führen Sie also jewils am Monatsende DFCComClearData nach Abruf der Datensätze aus, können Sie mit Hilfe dieser Funktion eine Art Monatsbackup auf den Geräten realisieren.

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

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

Seit

04.01.06 enthalten