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

Deklarationen für die Funktionen der Geräteverbindungen und deren direktem Zugriff. Mehr ...

#include "df_defines.h"

gehe zum Quellcode dieser Datei

Funktionen

DF_API_EXTERN int DF_API_CALL DFCComInit (int connectionId)
 Öffnet eine serielle Schnittstelle für die Kommunikation mit einem AEIII+ über RS232/RS485. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComOpenSerial (int connectionId, char *commPort, int baudRate, int timeout)
 Oeffnet die serielle Schnittstelle fuer RS232 / RS485 Direktkommunikation. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComOpen (int connectionId, char *hostAddress)
 Oeffnet die TCP/IP Schnittstelle. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComOpenSocket (int connectionId, char *hostAddress, int portNumber, int timeout)
 Oeffnet die TCP/IP Schnittstelle. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComOpenIV (int connectionId, int deviceAddress, int connectionType, char *connectionString, int connectionValue, int connectionTimeout)
 Oeffnet die Schnittstelle fuer die Kommunikation mit PZE Master IV. Mehr ...
 
DF_API_EXTERN void DF_API_CALL DFCComClose (int connectionId)
 Schliessen des geoeffneten Kanals. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCIsChannelOpen (int connectionId)
 Prueft ob die Schnittstelle bereits Initialisiert oder auch geoeffnet wurde. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCWrite (int connectionId, char *buffer, int toWrite, int *written, int *errorNumber)
 Schreibt Zeichen in den Kanal. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCRead (int connectionId, char *buffer, int toRead, int *read, int *errorNumber)
 Liest Zeichen vom Kanal. Mehr ...
 

Ausführliche Beschreibung

Deklarationen für die Funktionen der Geräteverbindungen und deren direktem Zugriff.

Autor
Bernd Ottmann
Datum
21.02.2003

Dokumentation der Funktionen

DF_API_EXTERN void DF_API_CALL DFCComClose ( int  connectionId)

Schliessen des geoeffneten Kanals.

Je nach dem Typ des Kanals wird entweder die serielle Schnittstelle oder der Socket geschlossen.

Parameter
connectionIdKommunikationskanalnummer.
Rückgabe
Keine.
// Close connection.
DFCComClose( connectionId );
DF_API_EXTERN int DF_API_CALL DFCComInit ( int  connectionId)

Öffnet eine serielle Schnittstelle für die Kommunikation mit einem AEIII+ über RS232/RS485.

Achtung
Diese Funktion sollten Sie nur für die Kommunikation mit AEIII+ Geräten verwenden, bei allen anderen Geräten sollten Sie DFCComOpenIV() zum öffnen einer Verbindung nutzen. Die Kommunikation startet bei Verwendung mit anderen Geräten verzögert, da vorher das zugrundeliegende Kommunikationsprotokoll ermittelt werden muss.

Die Funktion ruft intern die Funktion DFCComOpenSerial() mit den Standardparametern baudRate = 38400 und timeout = 800 auf.

Parameter
[in]connectionIdZu verwendende Verbindungs-Id. Diese wird für weitere Funktionsaufrufe zur Kommunikation benötigt. Bereich [1 - 400].
Rückgabewerte
1Serielle Schnittstelle erfolgreich geöffnet.
0Fehler bei öffnen der seriellen Schnittstelle.
DF_API_EXTERN int DF_API_CALL DFCComOpen ( int  connectionId,
char *  hostAddress 
)

Oeffnet die TCP/IP Schnittstelle.

Die Funktion ruft intern die Funktion DFCComOpenSocket() mit den Standardparametern iPortNum = 8000 und iTimeOut = 3000 auf.

Parameter
connectionIdKommunikationskanalnummer.
hostAddressZeiger auf String mit Hostnamen oder IP - Adresse in Punktnotation.
Rückgabe
Kommunikationskanal oeffnen.
Rückgabewerte
1Schnittstelle erfolgreich geoeffnet.
0Fehler bei Initialisierung.
DF_API_EXTERN int DF_API_CALL DFCComOpenIV ( int  connectionId,
int  deviceAddress,
int  connectionType,
char *  connectionString,
int  connectionValue,
int  connectionTimeout 
)

Oeffnet die Schnittstelle fuer die Kommunikation mit PZE Master IV.

Initialisiert den Kanal. Je nach angegebenem Typ wird ein anderes Initialisierungsverfahren verwendet um die entsprechend nachfolgenden Funktionsaufrufe der exportierten Funktionen richtig umzusetzen.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressDie von der DLL zu verwendende Busnummer. (Multimasteransatz)
connectionTypeDer zu verwendende Schnittstellentyp. 1 -> RS232 direkt oder über Umsetzter (RS232 <-> RS485) 2 -> Funk über den Umsetzer (RS232 <-> BIM2) ohne eigenen Kontroller. 3 -> TCP / IP - Verbindung.
connectionStringJe nach Schnittstellentyp: 1,2 -> Zeiger auf Zeichenkette für die Schnittstelle. "COM1" .. "COM4". 3 -> Zeiger auf Zeichenkette mit IP - Adresse oder Hostname.
connectionValueJe nach Schnittstellentyp: 1,2 -> Übertragungsrate der Schnittstelle. (Standard ist: 38400) 3 -> Portnummer des TCP / IP Anschlusses.
connectionTimeoutJe nach Schnittstellentyp: 1,2 ->Timeout für Lesen von Schnittstelle (Standard ist: 150) 3 -> Timeout für Lesen von Socket (Standard ist: 3000)
Rückgabe
Kommunikationskanal oeffnen.
Rückgabewerte
1Schnittstelle erfolgreich geoeffnet.
0Fehler bei Initialisierung.
int connectionId = 1;
int deviceAddress = 0;
// Open connection.
if ( DFCComOpenIV( connectionId, deviceAddress, 3, "192.168.1.2", 8000, 5000 ) == 0 )
{
// Fail to open connection.
return false;
}
// Do some other stuff...
// Close connection.
DFCComClose( connectionId );
DF_API_EXTERN int DF_API_CALL DFCComOpenSerial ( int  connectionId,
char *  commPort,
int  baudRate,
int  timeout 
)

Oeffnet die serielle Schnittstelle fuer RS232 / RS485 Direktkommunikation.

Es können zusätzliche Parameter verwendet werden. Die Baudrate ist standardmaessig auf 38400bd einzustellen und der Timeout liegt bei 150ms pro Lesevorgang.

Parameter
[in]connectionIdKommunikationskanalnummer.
[in]commPortZeiger auf String mit Namen der Schnittstelle "COM1", "COM2" usw..
[in]baudRateBaudrate mit der die Schnittstelle verwendet wird, 38400bd ist Standard.
[in]timeoutZu verwendender Timeout fuer Read - Befehl. (ReadFile)
Rückgabe
Kommunikationskanal oeffnen.
Rückgabewerte
1Schnittstelle erfolgreich geoeffnet.
0Fehler bei Initialisierung.
DF_API_EXTERN int DF_API_CALL DFCComOpenSocket ( int  connectionId,
char *  hostAddress,
int  portNumber,
int  timeout 
)

Oeffnet die TCP/IP Schnittstelle.

Es koennen zusaetzliche Parameter verwendet werden. Die Portnummer ist standardmaessig auf 8000 einzustellen und der Timeout (ein intern verwalteter) liegt bei 3000 pro Lesevorgang.

Parameter
connectionIdKommunikationskanalnummer.
hostAddressZeiger auf String mit Hostnamen oder IP - Adresse in Punktnotation.
portNumberPortnummer
timeoutZu verwendender Timeout bei Lesevorgang. (keine ms - Einheit)
Rückgabe
Kommunikationskanal oeffnen.
Rückgabewerte
1Schnittstelle erfolgreich geoeffnet.
0Fehler bei Initialisierung.
DF_API_EXTERN int DF_API_CALL DFCIsChannelOpen ( int  connectionId)

Prueft ob die Schnittstelle bereits Initialisiert oder auch geoeffnet wurde.

Parameter
connectionIdKommunikationskanalnummer.
Rückgabe
Kommunikationskanal oeffnen.
Rückgabewerte
-1Kanalobjekt noch nicht verfügbar, Schnittstelle nicht initialisiert oder geoeffnet.
0Schnittstelle nicht geoeffnet.
1Schnittstelle geoeffnet.
DF_API_EXTERN int DF_API_CALL DFCRead ( int  connectionId,
char *  buffer,
int  toRead,
int *  read,
int *  errorNumber 
)

Liest Zeichen vom Kanal.

Lesen von Daten aus dem Kanal.

Parameter
connectionIdKommunikationskanalnummer.
bufferZeiger auf Daten.
toReadLaenge der zu lesenden Daten.
readAnzahl der gelesenen Daten.
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 02.00.18 enthalten.
DF_API_EXTERN int DF_API_CALL DFCWrite ( int  connectionId,
char *  buffer,
int  toWrite,
int *  written,
int *  errorNumber 
)

Schreibt Zeichen in den Kanal.

Schreiben von Daten in den Kanal.

Parameter
connectionIdKommunikationskanalnummer.
bufferZeiger auf Daten.
toWriteLaenge der zu schreiben Daten.
writtenAnzahl der geschriebenen Daten.
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 02.00.18 enthalten.