Datafox DFCom - API 04.03.22
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
|
#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. | |
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.
_DFCComClearData@8
DFCComClearData
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
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.
_DFCComCollectData@12
DFCComCollectData
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
-1 | Fehler bei Ausführung. |
0 | Keine Datensätze vorhanden. |
1 | Es wurde ein Offline-Datensatz gelesen. |
2 | Es wurde ein Online-Datensatz gelesen. |
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.
_DFCComGetDatensatz@16
DFCComGetDatensatz
[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. |
-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. |
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.
_DFCDatBCnt@4
DFCDatBCnt
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
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.
_DFCDatBDatensatz@16
DFCDatBDatensatz
[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. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
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.
_DFCDatBFeld@24
DFCDatBFeld
[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.
| ||||||||||||||||||||||
[out] | size | Länge. Die Längenangabe beinhaltet ein eventuell benötigtes Nullterminierungszeichen bei Feldern für Zeichenfolgen. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
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.
_DFCLoadDatensatzbeschreibung@12
DFCLoadDatensatzbeschreibung
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
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.
_DFCQuitRecord@12
DFCQuitRecord
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
-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. |
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.
DFCQuitRecordExt
DFCQuitRecordExt
[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. |
-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. |
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.
_DFCReadRecord@20
DFCReadRecord
[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. |
-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. |
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.
_DFCRestoreRecords@12
DFCRestoreRecords
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |