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

Hauptinclude mit den allgemeinen Funktionen und Einbindung aller Untermodule. Mehr ...

#include "df_defines.h"
#include "df_connection.h"
#include "df_files.h"
#include "df_lists.h"
#include "df_log.h"
#include "df_setup_records.h"
#include "df_setup_lists.h"
#include "df_access_control_lists_v1.h"
#include "df_access_control.h"
#include "df_access_control_lists.h"
#include "df_system_records.h"
#include "df_fingerprint.h"
#include "df_active_mode.h"

gehe zum Quellcode dieser Datei

Funktionen

DF_API_EXTERN int DF_API_CALL DFCCheckAE (int connectionId, int deviceAddress)
 Pruefen ob das Geraet erreichbar ist. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCCheckDevice (int connectionId, int deviceAddress, int *errorNumber, int devicePollRetry)
 Pruefen ob das Geraet erreichbar ist. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComSetTime (int connectionId, int deviceAddress, unsigned char *dateTimeBuffer)
 Setzt das uebergebene Datum und die Uhrzeit in dem Geraet. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComGetTime (int connectionId, int deviceAddress, unsigned char *dateTimeBuffer)
 Holt das Datum und die Uhrzeit aus dem Geraet. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComSendMessage (int connectionId, int deviceAddress, unsigned char visibleTime, unsigned char doAction, unsigned char audibleSignal, char *text, int textLength)
 Direktes schreiben einer Textnachricht. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCComSendInfotext (int connectionId, int deviceAddress, char *text, int textLength)
 Indirektes schreiben einer Textnachricht. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCGetSeriennummer (int connectionId, int deviceAddress, int *errorNumber, int *value)
 Die Seriennummer aus dem Geraet lesen. Mehr ...
 
DF_API_EXTERN void DF_API_CALL DFCSetCallBack (int connectionId, int(*functionPointer)(void))
 Setzen einer Rueckruffunktion. Mehr ...
 
DF_API_EXTERN void DF_API_CALL DFCGetErrorText (int connectionId, int errorNumber, int languageId, char *value, int valueLength)
 Aufloesen einer Fehlernummer in seine lesbare Bedeutung. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCSetGlobVar (int connectionId, int deviceAddress, unsigned char *name, int nameType, unsigned char *value, int *errorNumber)
 Setzen des Wertes einer Globalen Variablen. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCGetGlobVar (int connectionId, int deviceAddress, unsigned char *name, int nameType, unsigned char *value, int valueLength, int *errorNumber)
 Lesen des Wertes einer Globalen Variablen. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCCloseRelay (int connectionId, int deviceAddress, int number, int timeout, int *errorNumber)
 Schliessen eines angeschlossenen Relais. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCGetRelayState (int connectionId, int deviceAddress, int number, int *state, int *timeout, int *errorNumber)
 Abfragen von aktuellem Zustand und verbleibender Zeit. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCOpenRelay (int connectionId, int deviceAddress, int number, int *errorNumber)
 Oeffnen eines Relais. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCGetDevicePollRetry (int connectionId)
 Abfrage der zuletzt mit DFCCheckDevice() benoetigten Versuche. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCGetVersionFirmware (int connectionId, int deviceAddress, char *value, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCGetVersionFirmwareFromFile (int connectionId, char *filePath, char *value, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCReadHardwareInfo (int connectionId, int deviceAddress, char *value, int *valueLength, int flags, int *errorNumber)
 Die Hardware Info vom Geraet lesen. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCSetOptionFirmware (int connectionId, int deviceAddress, int mask, int options, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCGetOptionFirmware (int connectionId, int deviceAddress, int *mask, int *options, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCSetFontType (int connectionId, int deviceAddress, int type, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCPressVirtualKey (int connectionId, int deviceAddress, int keyCode, int flags, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCGetPasswordKey (int connectionId, int deviceAddress, char *value, int *valueLength, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCSetPassword (int connectionId, char *value, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCReset (int connectionId, int deviceAddress, int mode, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCGetFlashStatus (int connectionId, int deviceAddress, int *value, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCSetCommunicationPassword (int connectionId, unsigned char *value, int valueLength, int sessionTimeout, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCRecordVolume (int connectionId, int deviceAddress, int *recordCount, int *memoryUsage, int *memorySize, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCGetInfo (int connectionId, int deviceAddress, char *name, char *params, char *text, int *textLength, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCOpenComServerMode (int connectionId, int deviceAddress, char *comm, int baudRate, int byteSize, int parity, int stopBits, int flags, int timeoutToClose, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCCloseComServerMode (int connectionId, int deviceAddress, int *errorNumber)
 
DF_API_EXTERN int DF_API_CALL DFCVersionLibrary (char *value, int valueLength)
 Ermitteln der Libraryversion. Mehr ...
 

Ausführliche Beschreibung

Hauptinclude mit den allgemeinen Funktionen und Einbindung aller Untermodule.

Autor
Bernd Ottmann
Datum
21.02.2003

Dokumentation der Funktionen

DF_API_EXTERN int DF_API_CALL DFCCheckAE ( int  connectionId,
int  deviceAddress 
)

Pruefen ob das Geraet erreichbar ist.

Ruft intern die Funktion DFCCheckDevice() mit standard - Parametern auf.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
Rückgabe
Ergebnis der Erreichbarkeit.
Rückgabewerte
0Geraet ist nicht erreichbar.
1Es wurde erfolgreich auf das Geraet zugegriffen.
DF_API_EXTERN int DF_API_CALL DFCCheckDevice ( int  connectionId,
int  deviceAddress,
int *  errorNumber,
int  devicePollRetry 
)

Pruefen ob das Geraet erreichbar ist.

Prueft aufgrund einer kleinen Datenanfrage die Erreichbarkeit des Geraetes.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
errorNumberZeiger auf Variable die nach Fehler den Fehlercode erhaelt.
devicePollRetryAnzahl der Wiederholversuche.
Rückgabe
Ergebnis der Erreichbarkeit.
Rückgabewerte
0Geraet ist nicht erreichbar.
1Es wurde erfolgreich auf das Geraet zugegriffen.
DF_API_EXTERN int DF_API_CALL DFCCloseRelay ( int  connectionId,
int  deviceAddress,
int  number,
int  timeout,
int *  errorNumber 
)

Schliessen eines angeschlossenen Relais.

Internen digitalen Ausgang oder externen digitalen Ausgang (z.B. IOModule) fuer eine bestimmbare Zeit schalten.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
numberGibt die Nummer des zu schaltenden Relais an.
timeoutGibt die Zeit in Sekunden an, in welcher das Relais geschaltet bleibt.
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 2.0.5 enthalten.
DF_API_EXTERN int DF_API_CALL DFCComGetTime ( int  connectionId,
int  deviceAddress,
unsigned char *  dateTimeBuffer 
)

Holt das Datum und die Uhrzeit aus dem Geraet.

Das Datum mit Uhrzeit wird in einem speziellen Format abgelegt, welches in der Dokumentation zur DLL beschrieben ist.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
dateTimeBufferZeiger auf Bytearray mit Werten fuer Datum und Uhrzeit.
Rückgabe
Ergebnis der Wertermittlung aus dem Geraet.
Rückgabewerte
0Wert konnte nicht ermittelt werden.
1Wert wurde erfolgreich ermittelt.
DF_API_EXTERN int DF_API_CALL DFCComSendInfotext ( int  connectionId,
int  deviceAddress,
char *  text,
int  textLength 
)

Indirektes schreiben einer Textnachricht.

Der gesendete Text wird in einem eigens dafuer vorgesehenen Speicherbereich abgelegt und kann ueber die Pfeiltasten in den "nicht PZE-Moden" erreicht werden.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
textZeiger auf den anzuzeigenden Text.
textLengthLaenge des anzuzeigenden Textes.
Rückgabe
Ergebnis der Textsendung an Geraet.
Rückgabewerte
0Text konnte nicht geschrieben werden.
1Text wurde erfolgreich geschrieben.
DF_API_EXTERN int DF_API_CALL DFCComSendMessage ( int  connectionId,
int  deviceAddress,
unsigned char  visibleTime,
unsigned char  doAction,
unsigned char  audibleSignal,
char *  text,
int  textLength 
)

Direktes schreiben einer Textnachricht.

Der gesendete Text wird fuer eine bestimmbare Zeit und mit einer eventuell akustischen Signalisierung auf der Anzeige ausgegeben. Die Ausgabe ist vom Geraetezustand abhaengig.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
visibleTimeAnzeigedauer. (ucDelayTime 250ms). 255->nicht automatisch wegblenden.
doActionIst fuer eingriffe in die Bedienung vorgesehen.
audibleSignalMeldung aktustisch untermalen.
textZeiger auf den anzuzeigenden Text.
textLengthLaenge des anzuzeigenden Textes.
Rückgabe
Ergebnis der Textsendung an Geraet.
Rückgabewerte
0Text konnte nicht geschrieben werden.
1Text wurde erfolgreich geschrieben.
DF_API_EXTERN int DF_API_CALL DFCComSetTime ( int  connectionId,
int  deviceAddress,
unsigned char *  dateTimeBuffer 
)

Setzt das uebergebene Datum und die Uhrzeit in dem Geraet.

Das zuvor aufbereitete Datum mit Uhrzeit muss in einem speziellen Format vorliegen, welches in der Dokumentation zur DLL beschrieben ist.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
dateTimeBufferZeiger auf Bytearray mit Werten fuer Datum und Uhrzeit.
Rückgabe
Ergebnis der Wertsetzung im Geraet.
Rückgabewerte
0Wert konnte nicht gesetz werden.
1Wert wurde erfolgreich gesetzt.
DF_API_EXTERN int DF_API_CALL DFCGetDevicePollRetry ( int  connectionId)

Abfrage der zuletzt mit DFCCheckDevice() benoetigten Versuche.

Die Anzahl der benoetigten Versuche koennen fuer eventuelle Statistikzwecke verwendet werden.

Parameter
connectionIdKommunikationskanalnummer.
Rückgabe
Anzahl der benoetigten Versuche bis Geraet als verfuegbar galt.
Version
Ab DLL - Version 2.0.5 enthalten.
DF_API_EXTERN void DF_API_CALL DFCGetErrorText ( int  connectionId,
int  errorNumber,
int  languageId,
char *  value,
int  valueLength 
)

Aufloesen einer Fehlernummer in seine lesbare Bedeutung.

Die von den meisten Funktionen ueber den Parameter errorNumber zurueckgegebene Fehlernummer kann mit dieser Funktion in seine lesbare Bedeutung umgewandelt werden.

Parameter
connectionIdKommunikationskanalnummer.
errorNumberFehlernummer.
languageIdAngabe der zu verwendenden Sprache.
valueZeiger auf die Zeichenfolge, welche den Fehlertext erhaelt.
valueLengthLaenge in Anzahl Byte des Speicherbereichs auf den szText verweist.
Rückgabe
Keine.
Version
Ab DLL - Version 2.0.3 enthalten.
DF_API_EXTERN int DF_API_CALL DFCGetGlobVar ( int  connectionId,
int  deviceAddress,
unsigned char *  name,
int  nameType,
unsigned char *  value,
int  valueLength,
int *  errorNumber 
)

Lesen des Wertes einer Globalen Variablen.

Der Wert einer Globalen Variablen kann mit Hilfe dieser Funktion vom PC aus gelesen werden. Diese muss natuerlich im verwendeten Geraetesetup definiert sein.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
nameZeiger auf Byte welches die logische Variablennummer enthaelt, oder auf eine Zeichenfolge, welche den Variablennamen darstellt.
nameTypeGibt an ob name auf eine Variablennummer oder auf einen Variablennamen verweist.
valueZeiger auf ermittelte nullterminierte Zeichenfolge.
valueLengthLaenge in Anzahl Byte des Speicherbereichs auf den pucValue verweist.
errorNumberZeiger auf Variable die nach Fehler den Fehlercode erhaelt.
Rückgabe
Ergebnis der Wertermittlung aus Geraet.
Rückgabewerte
0Wert konnte nicht ermittelt werden.
1Wert wurde erfolgreich ermittelt.
Version
Ab DLL - Version 2.0.4 enthalten.
DF_API_EXTERN int DF_API_CALL DFCGetRelayState ( int  connectionId,
int  deviceAddress,
int  number,
int *  state,
int *  timeout,
int *  errorNumber 
)

Abfragen von aktuellem Zustand und verbleibender Zeit.

Der aktuelle Zustand und die verbleibende Zeit bei geschlossenem Relais abfragen.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
numberGibt die Nummer des zu schaltenden Relais an.
stateZeiger auf eine Variable, welche den aktuellen Schaltzustand des Ausgangs erhaelt.
timeoutZeiger auf die Variable, welche die verbleibende Zeit in Sekunden 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.
Version
Ab DLL - Version 2.0.5 enthalten.
DF_API_EXTERN int DF_API_CALL DFCGetSeriennummer ( int  connectionId,
int  deviceAddress,
int *  errorNumber,
int *  value 
)

Die Seriennummer aus dem Geraet lesen.

Gibt die gelesene Seriennummer als Ganzzahl ueber Parameter zurueck.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
errorNumberZeiger auf Variable die nach Fehler den Fehlercode erhaelt.
valueZeiger auf Variable welche die Seriennummer erhaelt.
Rückgabe
Ergebnis der Werteermittlung.
Rückgabewerte
0Wert konnte nicht ermittelt werden und Fehlercode wurde ueber errorNumber abgelegt.
1Seriennummer wurde ueber piSerialNum in Variable uebergeben.
DF_API_EXTERN int DF_API_CALL DFCOpenRelay ( int  connectionId,
int  deviceAddress,
int  number,
int *  errorNumber 
)

Oeffnen eines Relais.

Internen digitalen Ausgang oder externen digitalen Ausgang (z.B. IOModule) schalten.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
numberGibt die Nummer des zu schaltenden Relais an.
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 2.0.5 enthalten.
DF_API_EXTERN int DF_API_CALL DFCReadHardwareInfo ( int  connectionId,
int  deviceAddress,
char *  value,
int *  valueLength,
int  flags,
int *  errorNumber 
)

Die Hardware Info vom Geraet lesen.

Liest die Hardware Info aus dem Geraet und schreibt sie in eine anzugebende Ini-Datei.

Parameter
[in]connectionIdKommunikationskanalnummer.
[in]deviceAddressBusnummer des anzusprechenden Geraetes.
[out]valueZeiger auf den String fuer die Hardwareinfo.
[in]valueLengthZeiger auf die Laengenangabe des Strings.
[in]flagsZusatzangaben. (noch unverwendet)
[out]errorNumberZeiger auf Variable die nach Fehler den Fehlercode erhaelt.
Rückgabe
Ergebnis der Werteermittlung.
Rückgabewerte
1Werte wurden ermittelt und in Ini-Datei abgelegt.
0Fehler bei Werteermittlung, Fehlernummer ueber Parameter errorNumber ermittelbar.
DF_API_EXTERN void DF_API_CALL DFCSetCallBack ( int  connectionId,
int(*)(void)  functionPointer 
)

Setzen einer Rueckruffunktion.

Die Rueckruffunktion wird waehrend des Kommunikationsablaufs fortwaehrend aufgerufen und bietet die Moeglichkeit eines fruehzeitigen abbruches des selbigen.

Parameter
connectionIdKommunikationskanalnummer.
functionPointerZeiger auf die Rueckruffunktion oder 0 fuer abschalten.
Rückgabe
Keine.
Version
Ab DLL - Version 2.0.0 enthalten.
DF_API_EXTERN int DF_API_CALL DFCSetGlobVar ( int  connectionId,
int  deviceAddress,
unsigned char *  name,
int  nameType,
unsigned char *  value,
int *  errorNumber 
)

Setzen des Wertes einer Globalen Variablen.

Der Wert einer Globalen Variablen kann mit Hilfe dieser Funktion vom PC aus abgeaendert werden. Diese muss natuerlich im verwendeten Geraetesetup definiert sein.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
nameZeiger auf Byte welches die logische Variablennummer enthaelt, oder auf eine Zeichenfolge, welche den Variablennamen darstellt.
nameTypeGibt an ob name auf eine Variablennummer oder auf einen Variablennamen verweist.
valueZeiger auf den Wert der gesetzt werden soll.
errorNumberZeiger auf Variable die nach Fehler den Fehlercode erhaelt.
Rückgabe
Ergebnis der Wertuebernahme im Geraet.
Rückgabewerte
0Wert konnte nicht uebernommen werden.
1Wert wurde erfolgreich uebernommen.
Version
Ab DLL - Version 2.0.4 enthalten.
DF_API_EXTERN int DF_API_CALL DFCVersionLibrary ( char *  value,
int  valueLength 
)

Ermitteln der Libraryversion.

Die Version wird im Format XX.XX.XX.XX geliefert.

Parameter
valueZeiger auf Zeichenfolgenpuffer für die Version.
valueLengthLänge des reservierten Puffers für die Zeichenfolge. Muss mindestens 12 sein.
Rückgabe
Ergebnis der Ausfuehrung.
Rückgabewerte
0Parameter außerhalb des Gültigkeitsbereichs.
1Funktion wurde erfolgreich durchgefuehrt.
Version
Ab DLL - Version 04.03.00 enthalten.