Dokumentation zur DFComDLL.dll / DFCom_x64.dll  04.03.05.00
df_setup_records.h-Dateireferenz

Deklarationen für die Funktionen der Setupdatensätze. Mehr ...

#include "df_defines.h"

gehe zum Quellcode dieser Datei

Funktionen

DF_API_EXTERN int DF_API_CALL DFCComClearData (int connectionId, int deviceAddress)
 Datenzeiger ruecksetzen. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComCollectData (int connectionId, int deviceAddress, int *errorNumber)
 Daten aus Geraet lesen. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComGetDatensatz (int connectionId, unsigned char *buffer, int *bufferSize, int *errorNumber)
 Datensatz aus DLL / Geraet lesen. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCLoadDatensatzbeschreibung (int connectionId, int deviceAddress, int *errorNumber)
 Tabellenbeschreibungen fuer Datensaetze aus Geraet lesen. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCDatBCnt (int connectionId)
 Anzahl der Tabellenbeschreibungen fuer Datensaetze ermitteln. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCDatBDatensatz (int connectionId, int number, unsigned char *name, int *fieldCount)
 Grunddaten einer Tabellenbeschreibungen fuer Datensaetze ermitteln. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCDatBFeld (int connectionId, int datBNumber, int number, unsigned char *name, int *type, int *size)
 Grunddaten eines Tabellenfeldes fuer Datensaetze ermitteln. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCReadRecord (int channelID, int deviceAddress, char *buffer, int *bufferSize, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCQuitRecord (int channelID, int deviceAddress, int *errorNumber)
 

Ausführliche Beschreibung

Deklarationen für die Funktionen der Setupdatensätze.

Autor
Bernd Ottmann
Datum
21.02.2003

Dokumentation der Funktionen

DF_API_EXTERN int DF_API_CALL DFCComClearData ( int  connectionId,
int  deviceAddress 
)

Datenzeiger ruecksetzen.

Die Datenzeiger im Geraet werden rueckgesetzt. Die im Geraet eventuell enthaltenen Datensaetze werden dadurch geloescht.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
Rückgabe
Ergebnis der Ausfuehrung.
Rückgabewerte
0Funktion konnte nicht ausgefuehrt werden.
1Funktion wurde erfolgreich ausgefuehrt.
Version
Ab DLL - Version 2.0.0 enthalten.
DF_API_EXTERN int DF_API_CALL DFCComCollectData ( int  connectionId,
int  deviceAddress,
int *  errorNumber 
)

Daten aus Geraet lesen.

Es wird versucht die Daten aus dem Geraet in die DLL zu uebertragen.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
errorNumberZeiger auf Variable die nach Fehler den Fehlercode erhaelt.
Rückgabe
Ergebnis der Ausfuehrung.
Rückgabewerte
0Funktion konnte nicht ausgefuehrt werden.
1Funktion wurde erfolgreich ausgefuehrt.
Zu beachten
Ab DLL - Version 2.0.0 satzweise lesen.
DF_API_EXTERN int DF_API_CALL DFCComGetDatensatz ( int  connectionId,
unsigned char *  buffer,
int *  bufferSize,
int *  errorNumber 
)

Datensatz aus DLL / Geraet lesen.

Es wird versucht einen Datensatz aus der DLL / oder Geraet an den Aufrufer zu uebergeben. Die Busnummer ist durch vorherigen Aufruf der Funktion DFCComCollectData() bekannt.

Parameter
connectionIdKommunikationskanalnummer.
bufferZeiger auf den Puffer, welcher die Daten eines Datensatzes erhaelt.
bufferSizeZeiger auf Variable welche die Datensatzlaenge erhaelt.
errorNumberZeiger auf Variable die nach Fehler den Fehlercode erhaelt.
Rückgabe
Ergebnis der Ausfuehrung.
Rückgabewerte
0Funktion konnte nicht ausgefuehrt werden.
1Funktion wurde erfolgreich ausgefuehrt.
Zu beachten
Ab DLL - Version 2.0.0 satzweise lesen.
DF_API_EXTERN int DF_API_CALL DFCDatBCnt ( int  connectionId)

Anzahl der Tabellenbeschreibungen fuer Datensaetze ermitteln.

Auf Grundlage der zuvor mit DFCLoadDatensatzbeschreibung() gelesenen Daten, wird die Anzahl der definierten Tabellen zurueckgegeben.

Parameter
connectionIdKommunikationskanalnummer.
Rückgabe
Anzahl der mit DFCLoadDatensatzbeschreibung() gelesenen Tabellendefinitionen.
Version
Ab DLL - Version 1.1.i enthalten.
DF_API_EXTERN int DF_API_CALL DFCDatBDatensatz ( int  connectionId,
int  number,
unsigned char *  name,
int *  fieldCount 
)

Grunddaten einer Tabellenbeschreibungen fuer Datensaetze ermitteln.

Auf Grundlage der zuvor mit DFCLoadDatensatzbeschreibung() gelesenen Daten, werden die Grunddaten zu einer Tabellen zurueckgegeben.

Parameter
connectionIdKommunikationskanalnummer.
numberTabellennummer im Bereich von (0 - (DFCDatBCnt() - 1)).
nameZeiger auf Speicherbereich fuer Tabellenname. (Mindestens 17 Zeichen).
fieldCountZeiger auf Variable, welche die Feldanzahl der Tabelle erhaelt.
Rückgabe
Ergebnis der Ausfuehrung.
Rückgabewerte
0Funktion konnte nicht ausgefuehrt werden. (Tabelle nicht definiert!)
1Funktion wurde erfolgreich ausgefuehrt.
Version
Ab DLL - Version 1.1.i enthalten.
DF_API_EXTERN int DF_API_CALL DFCDatBFeld ( int  connectionId,
int  datBNumber,
int  number,
unsigned char *  name,
int *  type,
int *  size 
)

Grunddaten eines Tabellenfeldes fuer Datensaetze ermitteln.

Auf Grundlage der zuvor mit DFCLoadDatensatzbeschreibung() gelesenen Daten, werden die Grunddaten zu einem Tabellenfeld zurueckgegeben.

Parameter
connectionIdKommunikationskanalnummer.
datBNumberTabellennummer im Bereich von (0 - (DFCDatBCnt() - 1)).
numberFeldnummer.
nameZeiger auf Speicherbereich fuer Feldname. (Mindestens 17 Zeichen).
typeZeiger auf Variable, welche den Feldtyp erhaelt.
sizeZeiger auf Variable, welche die definierte Laenge des Feldes erhaelt, in dieser ist auch das Nullterminierungszeichen enthalten.
Rückgabe
Ergebnis der Ausfuehrung.
Rückgabewerte
0Funktion konnte nicht ausgefuehrt werden. (Tabelle nicht definiert!)
1Funktion wurde erfolgreich ausgefuehrt.
Version
Ab DLL - Version 1.1.i enthalten.
DF_API_EXTERN int DF_API_CALL DFCLoadDatensatzbeschreibung ( int  connectionId,
int  deviceAddress,
int *  errorNumber 
)

Tabellenbeschreibungen fuer Datensaetze aus Geraet lesen.

Es wird versucht die Tabellenbeschreibungen aus dem Geraet zu lesen. Hiernach koennen mit den Funktionen DFCDatBCnt(), DFCDatBDatensatz() und DFCDatBFeld() auf den ermittelten Daten gearbeitet werden.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
errorNumberZeiger auf Variable die nach Fehler den Fehlercode erhaelt.
Rückgabe
Ergebnis der Ausfuehrung.
Rückgabewerte
0Funktion konnte nicht ausgefuehrt werden.
1Funktion wurde erfolgreich ausgefuehrt.
Version
Ab DLL - Version 1.1.i enthalten.