Datafox DFCom - API  04.03.11.00
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 connectionId)
 Bibliotheksinterne Datenpuffer für Setuplisten löschen und initalisieren. Mehr ...
 
int DF_API_CALL DFCMakeListe (int connectionId, 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. Mehr ...
 
int DF_API_CALL DFCLoadListen (int connectionId, int deviceAddress, int *errorNumber)
 Übertragen der bibliotheksinternen Datenpuffer zum Gerät. Mehr ...
 
int DF_API_CALL DFCLoadListenbeschreibung (int connectionId, int deviceAddress, int *errorNumber)
 Aufbau der Listentabellen aus dem Geräte lesen. Mehr ...
 
int DF_API_CALL DFCListBCnt (int connectionId)
 Anzahl der gelesenen Listentabellen abrufen. Mehr ...
 
int DF_API_CALL DFCListBDatensatz (int connectionId, int number, char *name, int *fieldCount, int *unused_setTo0)
 Grunddaten einer Listentabelle abrufen. Mehr ...
 
int DF_API_CALL DFCListBFeld (int connectionId, int listBNumber, int number, char *name, int *type, int *size)
 Grunddaten eines Listenfeldes abrufen. Mehr ...
 

Dokumentation der Funktionen

◆ DFCClrListenBuffer()

void DF_API_CALL DFCClrListenBuffer ( int  connectionId)

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]connectionIdZu verwendende Verbindungs-Id.

◆ DFCListBCnt()

int DF_API_CALL DFCListBCnt ( int  connectionId)

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]connectionIdZu verwendende Verbindungs-Id.
Rückgabe
Anzahl der Listentabellen.

◆ DFCListBDatensatz()

int DF_API_CALL DFCListBDatensatz ( int  connectionId,
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
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]numberListennummer. Bereich 0 bis DFCListBCnt() - 1
[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  connectionId,
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
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]listBNumberTabellennummer im Bereich von (0 - (DFCListBCnt() - 1)).
[in]numberFeldnummer. Bereich 0 bis maximal 25.
[out]nameZeichenpuffer für den Feldnamen. Muss mindestens 17 Zeichen lang sein.
[out]typeDatentyp.
WertBedeutung
1unsigned long 4 Bytes
2Date und Time 7 Bytes
3Wie Typ 4, es sind jedoch nur Ziffern erlaubt
4Alpha-Numerisch ASCII
5Datum 4 Bytes
6Zeit 3 Bytes
[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  connectionId,
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
Achtung
Bitte beachten Sie die Hinweise zur Lebensdauer der eingesetzten Flash-Bausteine. Diese gelten ebenfalls für Zutrittslisten.
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[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  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[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  connectionId,
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
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[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-2018 Datafox GmbH