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

gehe zum Quellcode dieser Datei

Funktionen

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

Dokumentation der Funktionen

◆ DFCComClearData()

int DF_API_CALL DFCComClearData ( int  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCComCollectData()

int DF_API_CALL DFCComCollectData ( int  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
-1Fehler bei Ausführung.
0Keine Datensätze vorhanden.
1Es wurde ein Offline-Datensatz gelesen.
2Es wurde ein Online-Datensatz gelesen.

◆ DFCComGetDatensatz()

int DF_API_CALL DFCComGetDatensatz ( int  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[out]bufferDatenpuffer.
[in,out]bufferSizeAls [in] die reservierte Größe von buffer, als [out] die übergebene Datensatzlänge.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
-1Fehler bei Ausführung.
0Keine weiteren Datensätze vorhanden.
1Es wurde ein Offline-Datensatz übergeben.
2Es wurde ein Online-Datensatz übergeben. Auch letzter Datensatz.

◆ DFCDatBCnt()

int DF_API_CALL DFCDatBCnt ( int  connectionId)

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

◆ DFCDatBDatensatz()

int DF_API_CALL DFCDatBDatensatz ( int  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[in]numberDatensatznummer. Bereich 0 bis DFCDatBCnt() - 1
[out]nameZeichenpuffer für den Namen. Muss mindestens 17 Zeichen lang sein.
[out]fieldCountAnzahl der Felder.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCDatBFeld()

int DF_API_CALL DFCDatBFeld ( int  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[in]datBNumberDatensatznummer. Bereich 0 bis DFCDatBCnt() - 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.

◆ DFCLoadDatensatzbeschreibung()

int DF_API_CALL DFCLoadDatensatzbeschreibung ( int  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCQuitRecord()

int DF_API_CALL DFCQuitRecord ( int  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
-1Fehler bei Ausführung.
0Keine Quittung benötigt.
1Online-Datensatz quittiert.
2Wiederholt einen Online-Datensatz quittiert.
3Offline-Datensatz quittiert.
4Wiederholt einen Offline-Datensatz quittiert.

◆ DFCReadRecord()

int DF_API_CALL DFCReadRecord ( int  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]bufferDatenpuffer.
[in,out]bufferSizeAls [in] die reservierte Größe von buffer, als [out] die übergebene Datensatzlänge.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
-1Fehler bei Ausführung.
0Keine Datensätze vorhanden.
1Online-Datensatz gelesen.
2Wiederholt ein Online-Datensatz gelesen.
3Offline-Datensatz gelesen.
4Wiederholt ein Offline-Datensatz gelesen.

◆ DFCRestoreRecords()

int DF_API_CALL DFCRestoreRecords ( int  connectionId,
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]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.01.06 enthalten

© 2003-2018 Datafox GmbH