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 | |
DF_API_EXTERN int DF_API_CALL | DFCTableOpen (int connectionNumber, int deviceAddress, const char *name, int options, int *tableHandle) |
Öffnet eine vorhandene Tabelle (Liste) zur Bearbeitung. | |
DF_API_EXTERN int DF_API_CALL | DFCTableClose (int connectionNumber, int deviceAddress, int tableHandle) |
Schließt eine geöffnete Tabelle. | |
DF_API_EXTERN int DF_API_CALL | DFCTableSetFilter (int connectionNumber, int deviceAddress, int tableHandle, const char *value) |
Setzen eines Datenfilters auf die Tabelle. | |
DF_API_EXTERN int DF_API_CALL | DFCTableGetFilter (int connectionNumber, int deviceAddress, int tableHandle, char *value, int *valueSize) |
Lesen des Datenfilters der Tabelle. | |
DF_API_EXTERN int DF_API_CALL | DFCTableRemoveFilter (int connectionNumber, int deviceAddress, int tableHandle) |
Entfernen eines gesetzten Datenfilters von der Tabelle. | |
DF_API_EXTERN int DF_API_CALL | DFCTableGetRowCount (int connectionNumber, int deviceAddress, int tableHandle, int *currentCount, int *unsortedCount, int *deletedCount) |
Ermittlung der aktuellen Datensatzanzahl. | |
DF_API_EXTERN int DF_API_CALL | DFCTableGetCurrentRow (int connectionNumber, int deviceAddress, int tableHandle, int *currentRow) |
Ermittelt die aktuelle Zeilennummer. | |
DF_API_EXTERN int DF_API_CALL | DFCTableSetCurrentRow (int connectionNumber, int deviceAddress, int tableHandle, int offset, int direction) |
Setzen der aktuellen Zeilennummer. | |
DF_API_EXTERN int DF_API_CALL | DFCTableSetCurrentRowData (int connectionNumber, int deviceAddress, int tableHandle, int flags, char separator, const char *data, int dataSize) |
Überschreibt die aktuelle Datenzeile mit den angegeben Daten. | |
DF_API_EXTERN int DF_API_CALL | DFCTableSetCurrentColumnData (int connectionNumber, int deviceAddress, int tableHandle, int flags, const char *name, const char *data, int dataSize) |
Überschreiben eines Feldwertes. | |
DF_API_EXTERN int DF_API_CALL | DFCTableGetCurrentRowData (int connectionNumber, int deviceAddress, int tableHandle, int flags, char separator, char *data, int *dataSize) |
Liest die aktuelle Datenzeile. | |
DF_API_EXTERN int DF_API_CALL | DFCTableGetCurrentColumnData (int connectionNumber, int deviceAddress, int tableHandle, int flags, const char *name, char *data, int *dataSize) |
Lesen eines Feldwertes. | |
DF_API_EXTERN int DF_API_CALL | DFCTableSetAllRowsToColumnData (int connectionNumber, int deviceAddress, int tableHandle, int flags, const char *name, const char *data, int dataSize) |
Überschreiben einer Spalte der gesamten dem aktuellen Filterkriterium entsprechenden Datenzeilen. | |
DF_API_EXTERN int DF_API_CALL | DFCTableAppendRowData (int connectionNumber, int deviceAddress, int tableHandle, int flags, char separator, const char *data, int dataSize) |
Anfügen einer neuen Datenzeile. | |
DF_API_EXTERN int DF_API_CALL | DFCTableDeleteCurrentRow (int connectionNumber, int deviceAddress, int tableHandle, int flags) |
Aktuelle Datenzeile als gelöscht markieren. | |
DF_API_EXTERN int DF_API_CALL | DFCTableDeleteAvailableRows (int connectionNumber, int deviceAddress, int tableHandle, int flags) |
Markiert alle dem Filterkriterium enstsprechenden Datenzeilen als gelöscht. | |
DF_API_EXTERN int DF_API_CALL DFCTableAppendRowData | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int | flags, | ||
char | separator, | ||
const char * | data, | ||
int | dataSize | ||
) |
Anfügen einer neuen Datenzeile.
Der Tabelle wird die angegebene Datenzeile angefügt.
DFCTableAppendRowData
DFCTableAppendRowData
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||
[in] | tableHandle | Tabellenhandle. | ||||||||
[in] | flags | Gibt zusätzliche Funktionalitäten an.
| ||||||||
[in] | separator | Angabe der in data enthaltenen Datenfelder.
| ||||||||
[in] | data | Datenarray. | ||||||||
[in] | dataSize | Länge des Datenarrays. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableClose | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle | ||
) |
Schließt eine geöffnete Tabelle.
Schließt eine zuvor mit DFCTableOpen() geöffnete Tabelle.
DFCTableClose
DFCTableClose
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | tableHandle | Tabellenhandle. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableDeleteAvailableRows | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int | flags | ||
) |
Markiert alle dem Filterkriterium enstsprechenden Datenzeilen als gelöscht.
Durch einen folgenden Aufruf von DFCTableRemoveFilter() muss ein ggf. gesetzter Filter gelöscht werden. Wurde die Liste mit dem Flag für "Gesamte Liste" gelöscht, dann steht die Liste als Leere Liste zur Verfügung und kann mittels DFCTableAppendRowData() gefüllt werden. Sie muss mit DFCTableClose() geschlossen werden.
DFCTableDeleteAvailableRows
DFCTableDeleteAvailableRows
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||
[in] | tableHandle | Tabellenhandle. | |||||||||
[in] | flags | Gibt zusätzliche Funktionalitäten an.
|
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableDeleteCurrentRow | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int | flags | ||
) |
Aktuelle Datenzeile als gelöscht markieren.
Die aktuelle Datenzeile wird als gelöscht markiert und ein weiterer Zugriff ist nicht möglich.
DFCTableDeleteCurrentRow
DFCTableDeleteCurrentRow
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||
[in] | tableHandle | Tabellenhandle. | |||||||||
[in] | flags | Gibt zusätzliche Funktionalitäten an.
|
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableGetCurrentColumnData | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int | flags, | ||
const char * | name, | ||
char * | data, | ||
int * | dataSize | ||
) |
Lesen eines Feldwertes.
Liest aus der aktuellen Datenzeile den angegebenen Feldwert.
DFCTableGetCurrentColumnData
DFCTableGetCurrentColumnData
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||
[in] | tableHandle | Tabellenhandle. | |||||||||
[in] | flags | Gibt zusätzliche Funktionalitäten an.
| |||||||||
[in] | name | Feldname. | |||||||||
[in] | data | Datenarray. | |||||||||
[in,out] | dataSize | Als in die Länge des Datenarrays von data, als out die Anzahl übergebener Daten. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableGetCurrentRow | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int * | currentRow | ||
) |
Ermittelt die aktuelle Zeilennummer.
Ermittelt die Zeilennummer auf der aktuell der Satzzeiger steht.
DFCTableGetCurrentRow
DFCTableGetCurrentRow
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | tableHandle | Tabellenhandle. |
[out] | currentRow | Aktuelle Zeilennummer. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableGetCurrentRowData | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int | flags, | ||
char | separator, | ||
char * | data, | ||
int * | dataSize | ||
) |
Liest die aktuelle Datenzeile.
Die aktuelle Datenzeile wird in gelesen.
DFCTableGetCurrentRowData
DFCTableGetCurrentRowData
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||
[in] | tableHandle | Tabellenhandle. | |||||||||
[in] | flags | Gibt zusätzliche Funktionalitäten an.
| |||||||||
[in] | separator | Angabe der in data enthaltenen Datenfelder.
| |||||||||
[in] | data | Datenarray. | |||||||||
[in,out] | dataSize | Als in die Länge des Datenarrays von data, als out die Anzahl übergebener Daten. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableGetFilter | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
char * | value, | ||
int * | valueSize | ||
) |
Lesen des Datenfilters der Tabelle.
Wurde ein Datenfilter auf die Tabelle gesetzt wird dieser durch Aufruf gelesen.
DFCTableGetFilter
DFCTableGetFilter
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | tableHandle | Tabellenhandle. |
[in] | value | Zeichenarray für den Filterwert. |
[in] | valueSize | Als in die Länge des Zeichenarrays von value, als out die übergebene Anzahl Zeichen. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableGetRowCount | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int * | currentCount, | ||
int * | unsortedCount, | ||
int * | deletedCount | ||
) |
Ermittlung der aktuellen Datensatzanzahl.
Es wird zwischen Gesamtanzahl, unsortiert angefügter und als gelöscht markierter Datenzeilen unterschieden.
DFCTableGetRowCount
DFCTableGetRowCount
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | tableHandle | Tabellenhandle. |
[out] | currentCount | Gesamtanzahl ungelöschter Datenzeilen. |
[out] | unsortedCount | Anzahl unsortiert angefügter Datenzeilen. |
[out] | deletedCount | Anzahl als gelöscht markierter Datenzeilen. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableOpen | ( | int | connectionNumber, |
int | deviceAddress, | ||
const char * | name, | ||
int | options, | ||
int * | tableHandle | ||
) |
Öffnet eine vorhandene Tabelle (Liste) zur Bearbeitung.
Öffnet eine Tabelle und macht diese über einen Handle zugreifbar.
DFCTableOpen
DFCTableOpen
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||
[in] | name | Tabellenname. Die Tabellen sind in verschiedene Bereiche eingeteilt, welche Sie über einen Namenspräfix ansprechen.
| ||||||
[in] | options | Reservierter Parameter. Standardwert 0. | ||||||
[out] | tableHandle | Variable für den Tabellenhandle. Dieser wird bei den weiteren Funktionsaufrufen zur Bearbeitung als Parameterwert benötigt. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableRemoveFilter | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle | ||
) |
Entfernen eines gesetzten Datenfilters von der Tabelle.
Wurde mit DFCTableSetFilter() ein Filter auf die Tabelle gesetzt, kann dieser durch Aufruf entfernt werden.
DFCTableRemoveFilter
DFCTableRemoveFilter
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | tableHandle | Tabellenhandle. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableSetAllRowsToColumnData | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int | flags, | ||
const char * | name, | ||
const char * | data, | ||
int | dataSize | ||
) |
Überschreiben einer Spalte der gesamten dem aktuellen Filterkriterium entsprechenden Datenzeilen.
Allen, dem aktuell entpsrechenden Filterkriterium entsprechenden Datenzeilen, wird der angegebene Spaltenwert zugewiesen.
DFCTableSetAllRowsToColumnData
DFCTableSetAllRowsToColumnData
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||
[in] | tableHandle | Tabellenhandle. | ||||||
[in] | flags | Gibt zusätzliche Funktionalitäten an.
| ||||||
[in] | name | Feldname. | ||||||
[in] | data | Feldwert. | ||||||
[in] | dataSize | Länge des Feldwertes. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableSetCurrentColumnData | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int | flags, | ||
const char * | name, | ||
const char * | data, | ||
int | dataSize | ||
) |
Überschreiben eines Feldwertes.
Überschreibt in der aktuellen Datenzeile den angegebenen Feldwert.
DFCTableSetCurrentColumnData
DFCTableSetCurrentColumnData
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||
[in] | tableHandle | Tabellenhandle. | |||||||||
[in] | flags | Gibt zusätzliche Funktionalitäten an.
| |||||||||
[in] | name | Feldname. | |||||||||
[in] | data | Feldwert. | |||||||||
[in] | dataSize | Länge des Feldwertes. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableSetCurrentRow | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int | offset, | ||
int | direction | ||
) |
Setzen der aktuellen Zeilennummer.
Setzt den Satzzeiger auf die angegebene Zeilennummer.
DFCTableSetCurrentRow
DFCTableSetCurrentRow
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||
[in] | tableHandle | Tabellenhandle. | ||||||||
[in] | offset | Anzahl zu übergehender Datenzeilen. | ||||||||
[in] | direction | Worauf sich offset beziehen soll.
|
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableSetCurrentRowData | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
int | flags, | ||
char | separator, | ||
const char * | data, | ||
int | dataSize | ||
) |
Überschreibt die aktuelle Datenzeile mit den angegeben Daten.
Die Datenzeile auf welcher der aktuelle Satzzeiger steht wird mit den angegebenen Daten überschrieben.
DFCTableSetCurrentRowData
DFCTableSetCurrentRowData
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||
[in] | tableHandle | Tabellenhandle. | |||||||||
[in] | flags | Gibt zusätzliche Funktionalitäten an.
| |||||||||
[in] | separator | Angabe der in data enthaltenen Datenfelder.
| |||||||||
[in] | data | Datenarray. | |||||||||
[in] | dataSize | Länge des Datenarrays. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCTableSetFilter | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | tableHandle, | ||
const char * | value | ||
) |
Setzen eines Datenfilters auf die Tabelle.
Setzt ein Filterkriterium auf Spalten der Tabelle.
DFCTableSetFilter
DFCTableSetFilter
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | tableHandle | Tabellenhandle. |
[in] | value | Zeichenfolge des Filters. Die Filterangabe wird durch Spaltenname='Spaltenwert' durchgeführt. Ab der Firmwareversion 04.03.08.01 kann zusätzlich eine 2 Spalte angegeben werden: Spaltenname='Spaltenwert';Spaltenname2='Spaltenwert' |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |