Datafox DFCom - API 04.03.22
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
df_setup_lists.h-Dateireferenz
#include "df_defines.h"

gehe zum Quellcode dieser Datei

Funktionen

void DF_API_CALL DFCClrListenBuffer (int connectionNumber)
 Bibliotheksinterne Datenpuffer für Setuplisten löschen und initalisieren.
 
int DF_API_CALL DFCMakeListe (int connectionNumber, int number, int recordCount, int size, const unsigned char *buffer, int unused_setTo0)
 Kopieren eines aufbereiteten Datenarrays für eine Setupliste in den biblioteksinternen Datenpuffer.
 
int DF_API_CALL DFCLoadListen (int connectionNumber, int deviceAddress, int *errorNumber)
 Übertragen der bibliotheksinternen Datenpuffer zum Gerät.
 
int DF_API_CALL DFCLoadListenbeschreibung (int connectionNumber, int deviceAddress, int *errorNumber)
 Aufbau der Listentabellen aus dem Geräte lesen.
 
int DF_API_CALL DFCListBCnt (int connectionNumber)
 Anzahl der gelesenen Listentabellen abrufen.
 
int DF_API_CALL DFCListBDatensatz (int connectionNumber, int number, char *name, int *fieldCount, int *unused_setTo0)
 Grunddaten einer Listentabelle abrufen.
 
int DF_API_CALL DFCListBFeld (int connectionNumber, int listBNumber, int number, char *name, int *type, int *size)
 Grunddaten eines Listenfeldes abrufen.
 

Dokumentation der Funktionen

◆ DFCClrListenBuffer()

void DF_API_CALL DFCClrListenBuffer ( int  connectionNumber)

Bibliotheksinterne Datenpuffer für Setuplisten löschen und initalisieren.

Die in der Bibliothek bereitgestellten Datenpuffer für die zu übertragenenden Listendaten werden gelöscht und für eine Verwendung mittels DFCMakeListe() und DFCLoadListen() initalisiert.

Export
DFComDLL als _DFCClrListenBuffer@4
DFCom_x64 als DFCClrListenBuffer
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.

◆ DFCListBCnt()

int DF_API_CALL DFCListBCnt ( int  connectionNumber)

Anzahl der gelesenen Listentabellen abrufen.

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

Export
DFComDLL als _DFCListBCnt@4
DFCom_x64 als DFCListBCnt
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
Rückgabe
Anzahl der Listentabellen.

◆ DFCListBDatensatz()

int DF_API_CALL DFCListBDatensatz ( int  connectionNumber,
int  number,
char *  name,
int *  fieldCount,
int *  unused_setTo0 
)

Grunddaten einer Listentabelle abrufen.

Auf Grundlage der zuvor mit DFCLoadListenbeschreibung() gelesenen Listentabellen, werden die Grunddaten zu einer Listentabelle zurückgegeben.

Export
DFComDLL als _DFCListBDatensatz@20
DFCom_x64 als DFCListBDatensatz
Zu beachten
Für das Arbeiten mit den Strukturen der Zutrittslisten ist kein vorheriges Laden mit DFCLoadListenbeschreibung() nötig.
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
[in]numberListennummer.
BereichBedeutung
0 bis DFCListBCnt() - 1Nummer der Listenbeschreibung aus dem Setup
100 bis 103Ab DFCom Version 02.00.22 für die Zutrittslisten Version 1 (z. B. 102 für Liste "Personalstamm")
Offsetnummern der Listen siehe DFCMakeEntranceList()
200 bis 207Ab DFCom Version 04.01.00 für die Zutrittslisten Version 2 (z. B. 203 für Liste "Time")
Offsetnummern der Listen siehe DFCMakeEntrance2List()

[out]nameZeichenpuffer für den Namen. Muss mindestens 17 Zeichen lang sein.
[out]fieldCountAnzahl der Felder.
[out]unused_setTo0Variable welche eine 0 erhält. Reservierter Parameter.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCListBFeld()

int DF_API_CALL DFCListBFeld ( int  connectionNumber,
int  listBNumber,
int  number,
char *  name,
int *  type,
int *  size 
)

Grunddaten eines Listenfeldes abrufen.

Auf Grundlage der zuvor mit DFCLoadListenbeschreibung() gelesenen Listentabellen, werden die Grunddaten zu einem Listenfeld zurückgegeben.

Export
DFComDLL als _DFCListBFeld@24
DFCom_x64 als DFCListBFeld
Zu beachten
Für das Arbeiten mit den Strukturen der Zutrittslisten ist kein vorheriges Laden mit DFCLoadListenbeschreibung() nötig.
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
[in]listBNumberListennummer.
BereichBedeutung
0 bis DFCListBCnt() - 1Nummer der Listenbeschreibung aus dem Setup
100 bis 103Ab DFCom Version 02.00.22 für die Zutrittslisten Version 1 (z. B. 102 für Liste "Personalstamm")
Offsetnummern der Listen siehe DFCMakeEntranceList()
200 bis 207Ab DFCom Version 04.01.00 für die Zutrittslisten Version 2 (z. B. 203 für Liste "Time")
Offsetnummern der Listen siehe DFCMakeEntrance2List()
[in]numberFeldnummer. Bereich 0 bis maximal 25.
[out]nameZeichenpuffer für den Feldnamen. Muss mindestens 17 Zeichen lang sein.
[out]typeDatentyp.
WertBedeutung
1uint32 (4 Byte)
2DateTime (7 Byte, 4 Byte Date, 3 Byte Time)
3String (1-41 Byte, only digits [0-9])
4String (1-41 Byte, Latin1 codec)
5Date (4 Byte; Y100, Y, M, D)
6Time (3 Byte; h, m, s)
7Finger template (161 Byte; DIN V66400)
8Finger template (216 Byte; Idencom Compact)
9Binary data (1-220 Byte, Binär)
10Daten (2-241 Byte, Binär)
[out]sizeLänge. Die Längenangabe beinhaltet ein eventuell benötigtes Nullterminierungszeichen bei Feldern für Zeichenfolgen.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCLoadListen()

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

Übertragen der bibliotheksinternen Datenpuffer zum Gerät.

Es werden die mit DFCMakeListe() importierten Listendaten in das Gerät geschrieben. Vorhandene Listendaten werden hierbei erst nach einer erfolgreichen Übernahme überschrieben.

Export
DFComDLL als _DFCLoadListen@12
DFCom_x64 als DFCLoadListen
Zu beachten
Für die Verarbeitung der Listendaten siehe Listen des Setups.
Achtung
Bitte beachten Sie die Hinweise zur Lebensdauer der eingesetzten Flash-Bausteine. Diese gelten ebenfalls für Zutrittslisten.
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCLoadListenbeschreibung()

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

Aufbau der Listentabellen aus dem Geräte lesen.

Es werden die im Gerätesetup verwendeten Tabellenbeschreibungen für die Setuplisten in den Bibliotheksinternen Puffer gelesen. Hiernach kann mit den Funktionen DFCListBCnt(), DFCListBDatensatz() und DFCListBFeld() auf die ermittelten Daten zugegriffen werden.

Export
DFComDLL als _DFCLoadListenbeschreibung@12
DFCom_x64 als DFCLoadListenbeschreibung
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCMakeListe()

int DF_API_CALL DFCMakeListe ( int  connectionNumber,
int  number,
int  recordCount,
int  size,
const unsigned char *  buffer,
int  unused_setTo0 
)

Kopieren eines aufbereiteten Datenarrays für eine Setupliste in den biblioteksinternen Datenpuffer.

Das zu übergebende Datenarray wird in den Bibliotheksinternen Datenpuffer kopiert und für eine spätere Übertragung mittels DFCLoadListen() zwischengespeichert.

Export
DFComDLL als _DFCMakeListe@24
DFCom_x64 als DFCMakeListe
Zu beachten
Für die Verarbeitung der Listendaten siehe Listen des Setups.
Für die Aufbereitung der Listendaten siehe Importieren von Listendaten.
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
[in]numberListennnummer.
[in]recordCountAnzahl der Datensätze im übergebenen Datenarray.
[in]sizeAnzahl Byte des Datenarrays.
Brechnet sich aus (recordCount * Größe pro Datensatz).
[in]bufferDatenarray mit den Daten.
[in]unused_setTo0Sollte mit 0 übergeben werden. Reservierter Parameter.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

© 2003-2024 Datafox GmbH