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

Deklarationen der Funktionen für die Arbeit mit den Setuplisten. Mehr ...

#include "df_defines.h"

gehe zum Quellcode dieser Datei

Funktionen

DF_API_EXTERN int DF_API_CALL DFCMakeListe (int connectionId, int number, int recordCount, int size, unsigned char *buffer, int unused_setTo0)
 Setzen des Listenbuffers fuer eine Liste. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCLoadListen (int connectionId, int deviceAddress, int *errorNumber)
 Uebertragen der Listendaten zum Geraet. Mehr ...
 
DF_API_EXTERN void DF_API_CALL DFCClrListenBuffer (int connectionId)
 Buffer fuer Listendaten loeschen. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCLoadListenbeschreibung (int connectionId, int deviceAddress, int *errorNumber)
 Tabellenbeschreibungen fuer Listen aus Geraet lesen. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCListBCnt (int connectionId)
 Anzahl der Tabellenbeschreibungen fuer Listen ermitteln. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCListBDatensatz (int connectionId, int number, unsigned char *name, int *fieldCount, int *unused_setTo0)
 Grunddaten einer Tabellenbeschreibungen fuer Listen ermitteln. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCListBFeld (int connectionId, int listBNumber, int number, unsigned char *name, int *type, int *size)
 Grunddaten eines Tabellenfeldes fuer Listen ermitteln. Mehr ...
 

Ausführliche Beschreibung

Deklarationen der Funktionen für die Arbeit mit den Setuplisten.

Autor
Bernd Ottmann
Datum
21.02.2003

Dokumentation der Funktionen

DF_API_EXTERN void DF_API_CALL DFCClrListenBuffer ( int  connectionId)

Buffer fuer Listendaten loeschen.

Loescht in der DLL den Buffer fuer Listendaten. Die zuvor schon importierten Listen waehren nach Ausfuehrung wiederholt zu importieren.

Parameter
connectionIdKommunikationskanalnummer.
Rückgabe
Keine.
DF_API_EXTERN int DF_API_CALL DFCListBCnt ( int  connectionId)

Anzahl der Tabellenbeschreibungen fuer Listen ermitteln.

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

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

Grunddaten einer Tabellenbeschreibungen fuer Listen ermitteln.

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

Parameter
connectionIdKommunikationskanalnummer.
numberTabellennummer im Bereich von (0 - (DFCListBCnt() - 1)).
nameZeiger auf Speicherbereich fuer Tabellenname. (Mindestens 17 Zeichen).
fieldCountZeiger auf Variable, welche die Feldanzahl der Tabelle erhaelt.
unused_setTo0Zeiger auf Variable, welche immer eine 0 erhaelt. (Kompatible zu Timeboy)
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 DFCListBFeld ( int  connectionId,
int  listBNumber,
int  number,
unsigned char *  name,
int *  type,
int *  size 
)

Grunddaten eines Tabellenfeldes fuer Listen ermitteln.

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

Parameter
connectionIdKommunikationskanalnummer.
listBNumberTabellennummer im Bereich von (0 - (DFCListBCnt() - 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 DFCLoadListen ( int  connectionId,
int  deviceAddress,
int *  errorNumber 
)

Uebertragen der Listendaten zum Geraet.

Es wird versucht, die zuvor mit DFCMakeListe() importierten Listendaten in das Geraet 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.
DF_API_EXTERN int DF_API_CALL DFCLoadListenbeschreibung ( int  connectionId,
int  deviceAddress,
int *  errorNumber 
)

Tabellenbeschreibungen fuer Listen aus Geraet lesen.

Es wird versucht die Tabellenbeschreibungen aus dem Geraet zu lesen. Hiernach koennen mit den Funktionen DFCListBCnt(), DFCListBDatensatz() und DFCListBFeld() 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.
DF_API_EXTERN int DF_API_CALL DFCMakeListe ( int  connectionId,
int  number,
int  recordCount,
int  size,
unsigned char *  buffer,
int  unused_setTo0 
)

Setzen des Listenbuffers fuer eine Liste.

Die Listen muessen ihrer Reichenfolge nach (0 .. n) in den DLL internen Buffer uebertragen werden.

Parameter
connectionIdKommunikationskanalnummer.
numberTabellennummer.
recordCountAnzahl der Zeilen, Datensaetze im Block.
sizeAnzahl Byte im Block. Brechnet sich aus (Anzahl Datensaetzte Datensatzlaenge).
bufferZeiger auf Bytearray, welches die Daten enthaelt.
unused_setTo0Kann immer mit 0 uebergeben werden. (Kompatibel mit Timeboy)
Rückgabe
Ergebnis der Ausfuehrung.
Rückgabewerte
0Funktion konnte nicht ausgefuehrt werden.
1Funktion wurde erfolgreich ausgefuehrt.