Datafox DFCom - API 04.03.22
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
|
#include "df_defines.h"
#include "df_access_control.h"
#include "df_access_control_lists.h"
#include "df_access_control_lists_v1.h"
#include "df_active_mode.h"
#include "df_connection.h"
#include "df_files.h"
#include "df_fingerprint.h"
#include "df_lists.h"
#include "df_logging.h"
#include "df_setup_lists.h"
#include "df_setup_records.h"
#include "df_system_records.h"
#include "df_timeboy_lists.h"
gehe zum Quellcode dieser Datei
Funktionen | |
int DF_API_CALL | DFCCheckAE (int connectionNumber, int deviceAddress) |
Prüft ob das Gerät erreichbar ist. | |
int DF_API_CALL | DFCCheckDevice (int connectionNumber, int deviceAddress, int *errorNumber, int devicePollRetry) |
Prüft ob das Gerät erreichbar ist. | |
int DF_API_CALL | DFCComSetTime (int connectionNumber, int deviceAddress, const unsigned char *dateTimeBuffer) |
Setzt das übergebene Datum und die Uhrzeit in dem Gerät. | |
int DF_API_CALL | DFCComGetTime (int connectionNumber, int deviceAddress, unsigned char *dateTimeBuffer) |
Liest das Datum und die Uhrzeit aus dem Gerät. | |
int DF_API_CALL | DFCComSendMessage (int connectionNumber, int deviceAddress, unsigned char visibleTime, unsigned char doAction, unsigned char audibleSignal, const char *text, int textLength) |
Sendet eine Meldung ggf. zur Anzeige auf einem Display. | |
int DF_API_CALL | DFCComSendInfotext (int connectionNumber, int deviceAddress, const char *text, int textLength) |
Sendet eine Memonachricht an Geräte. | |
int DF_API_CALL | DFCGetSeriennummer (int connectionNumber, int deviceAddress, int *errorNumber, int *value) |
Die Seriennummer des Gerätes auslesen. | |
void DF_API_CALL | DFCSetCallBack (int connectionNumber, int(*functionPointer)(void)) |
Setzen einer Rückruffunktion. | |
void DF_API_CALL | DFCGetErrorText (int connectionNumber, int errorNumber, int languageId, char *value, int valueLength) |
Auflösen einer Fehlernummer in seine Textentsprechung. | |
int DF_API_CALL | DFCSetGlobVar (int connectionNumber, int deviceAddress, const char *name, int nameType, const char *value, int *errorNumber) |
Setzen des Wertes einer Setup- oder Systemvariablen. | |
int DF_API_CALL | DFCGetGlobVar (int connectionNumber, int deviceAddress, const char *name, int nameType, char *value, int valueLength, int *errorNumber) |
Lesen des Wertes einer Setup- oder Systemvariablen. | |
int DF_API_CALL | DFCCloseRelay (int connectionNumber, int deviceAddress, int number, int timeout, int *errorNumber) |
Schliessen eines Ausgangs (Relais). | |
int DF_API_CALL | DFCGetRelayState (int connectionNumber, int deviceAddress, int number, int *state, int *timeout, int *errorNumber) |
Abfragen des aktuellen Zustandes und der verbleibenden Zeit eines geschalteten Ausgangs (Relais). | |
int DF_API_CALL | DFCOpenRelay (int connectionNumber, int deviceAddress, int number, int *errorNumber) |
Öffnen eines Ausgangs (Relais). | |
int DF_API_CALL | DFCGetDevicePollRetry (int connectionNumber) |
Abfrage der zuletzt mit DFCCheckDevice() benötigten Anzahl Versuche. | |
int DF_API_CALL | DFCGetVersionFirmware (int connectionNumber, int deviceAddress, char *value, int *errorNumber) |
Liefert die im Gerät befindliche Firmwareversion und den Namenskürzel. | |
int DF_API_CALL | DFCSetOptionFirmware (int connectionNumber, int deviceAddress, int mask, int options, int *errorNumber) |
Setzt benötigte Zusatzoptionen der Firmware. | |
int DF_API_CALL | DFCGetOptionFirmware (int connectionNumber, int deviceAddress, int *mask, int *options, int *errorNumber) |
Liest die Werte der Zusatzoptionen zur Firmware. | |
int DF_API_CALL | DFCSetFontType (int connectionNumber, int deviceAddress, int type, int *errorNumber) |
Setzt den zu verwendenden Schrifttyp zur Darstellung der Nachrichten. | |
int DF_API_CALL | DFCPressVirtualKey (int connectionNumber, int deviceAddress, int keyCode, int flags, int *errorNumber) |
Über diese Funktion können Sie einen Tastendruck auslösen. | |
int DF_API_CALL | DFCSetPassword (int connectionNumber, const char *value, int *errorNumber) |
Setzen des zu verwendenden Setuppasswortes für diese Verbindung. | |
int DF_API_CALL | DFCReset (int connectionNumber, int deviceAddress, int mode, int *errorNumber) |
Reset je nach gewähltem Modus durchführen. | |
int DF_API_CALL | DFCSetCommunicationPassword (int connectionNumber, const char *value, int valueLength, int sessionTimeout, int *errorNumber) |
Setzen des zu verwendenden Verschlüsselungspasswortes der Kommunikation. | |
int DF_API_CALL | DFCRecordVolume (int connectionNumber, int deviceAddress, int *recordCount, int *memoryUsage, int *memorySize, int *errorNumber) |
int DF_API_CALL | DFCGetInfo (int connectionNumber, int deviceAddress, const char *name, const char *params, char *text, int *textLength, int *errorNumber) |
Lesen der Information eines bestimmten Moduls. | |
int DF_API_CALL | DFCVersionLibrary (char *value, int valueLength) |
Ermitteln der Libraryversion. | |
DF_API_EXTERN int DF_API_CALL | DFCGetLastErrorNumber (int connectionNumber, int deviceAddress) |
Liefert die Fehlernummer welche zuletzt aufgetreten ist. | |
DF_API_EXTERN int DF_API_CALL | DFCBlockTransferSetDuration (int connectionNumber, int deviceAddress, int blockTypesAllowed, int duration) |
Setzt für die entsprechende Geräteadresse oder die gesamte Verbindungsnummer eine Unterbrechungszeit. | |
DF_API_EXTERN int DF_API_CALL | DFCBlockTransferResume (int connectionNumber, int deviceAddress) |
Setzt eine bestehende Blockübertragung fort. | |
DF_API_EXTERN int DF_API_CALL | DFCBlockTransferGetState (int connectionNumber, int deviceAddress, int *currentType, int *currentState) |
Ruft den Typen und Zustand der ggf. vorhandenen Blockübertragung ab. | |
DF_API_EXTERN int DF_API_CALL | DFCBlockTransferDiscard (int connectionNumber, int deviceAddress) |
Verwirft eine aktuell laufende Blockübertragung. Die bis dahin übertragenen Daten werden verworfen. | |
DF_API_EXTERN int DF_API_CALL | DFCReadDataBlock (int connectionNumber, int deviceAddress, const char *name, char *data, int *length, int flags) |
Lesen eines Datenblocks. Dieses kann der Wert einer Systemvariablen oder der Inhalt einer Datei sein. | |
DF_API_EXTERN int DF_API_CALL | DFCGetDeviceId (int connectionNumber, int deviceAddress, int *value) |
Lesen einer eindeutigen Geräte-Id, alternativ zur Seriennummer und dem Gerätetypen. | |
DF_API_EXTERN int DF_API_CALL DFCBlockTransferDiscard | ( | int | connectionNumber, |
int | deviceAddress | ||
) |
Verwirft eine aktuell laufende Blockübertragung. Die bis dahin übertragenen Daten werden verworfen.
DFCBlockTransferDiscard
DFCBlockTransferDiscard
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCBlockTransferGetState | ( | int | connectionNumber, |
int | deviceAddress, | ||
int * | currentType, | ||
int * | currentState | ||
) |
Ruft den Typen und Zustand der ggf. vorhandenen Blockübertragung ab.
DFCBlockTransferGetState
DFCBlockTransferGetState
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||
[out] | currentType | Aktueller Blocktyp. Bei 0 ist keine Blockübertragung aktiv.
| |||||||||
[out] | currentState | Aktueller Zustand.
|
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCBlockTransferResume | ( | int | connectionNumber, |
int | deviceAddress | ||
) |
Setzt eine bestehende Blockübertragung fort.
DFCBlockTransferResume
DFCBlockTransferResume
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCBlockTransferSetDuration | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | blockTypesAllowed, | ||
int | duration | ||
) |
Setzt für die entsprechende Geräteadresse oder die gesamte Verbindungsnummer eine Unterbrechungszeit.
DFCBlockTransferSetDuration
DFCBlockTransferSetDuration
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||
[in] | blockTypesAllowed | Gibt an welche Blockübertragungen.
| |||||||||
[in] | duration | Zeitangabe in Sekunden, nach welcher eine laufende Übertragung unterbrochen werden soll. Die Funktion kommt in diesem Fall mit dem Rückgabewert 0 und liefert eine entsprechende Fehlernummer. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCCheckAE | ( | int | connectionNumber, |
int | deviceAddress | ||
) |
Prüft ob das Gerät erreichbar ist.
Prüft durch Abruf der Firmwareversion die Erreichbarkeit des Gerätes.
_DFCCheckAE@8
DFCCheckAE
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
0 | Nicht Erreichbar. Gerät antwortete nicht auf die Anfragen. |
1 | Erreichbar. |
int DF_API_CALL DFCCheckDevice | ( | int | connectionNumber, |
int | deviceAddress, | ||
int * | errorNumber, | ||
int | devicePollRetry | ||
) |
Prüft ob das Gerät erreichbar ist.
Prüft mittels angebbarer Anzahl Anfragen die Erreichbarkeit des Gerätes.
_DFCCheckDevice@16
DFCCheckDevice
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
[in] | devicePollRetry | Anzahl der Wiederholversuche bei älteren Protokollversionen. Ab Firmwareversionen größer 04.01.00 wird durch Aufruf von DFCGetVersionFirmware() die Erreichbarkeit des Gerätes geprüft und dieser Parameterwert ignoriert. |
0 | Nicht Erreichbar. Gerät antwortete nicht auf die Anfragen. |
1 | Erreichbar. |
int DF_API_CALL DFCCloseRelay | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | number, | ||
int | timeout, | ||
int * | errorNumber | ||
) |
Schliessen eines Ausgangs (Relais).
Internen digitalen Ausgang oder externen digitalen Ausgang (z.B. IO-Module) für eine bestimmbare Zeit schalten.
_DFCCloseRelay@20
DFCCloseRelay
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | number | Nummer des Ausgangs. Bereich 0 bis 40. |
[in] | timeout | Zeit in Sekunden, für welche der Ausgang geschaltet wird. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCComGetTime | ( | int | connectionNumber, |
int | deviceAddress, | ||
unsigned char * | dateTimeBuffer | ||
) |
Liest das Datum und die Uhrzeit aus dem Gerät.
Das Datum mit Uhrzeit wird in einen Datenarray abgelegt.
_DFCComGetTime@12
DFCComGetTime
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[out] | dateTimeBuffer | Datenarray für die Werte von Datum und Uhrzeit. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCComSendInfotext | ( | int | connectionNumber, |
int | deviceAddress, | ||
const char * | text, | ||
int | textLength | ||
) |
Sendet eine Memonachricht an Geräte.
Der gesendete Text wird in einem eigens dafür vorgesehenen Speicherbereich abgelegt und kann über die Pfeiltasten in den "nicht PZE-Moden" erreicht werden.
_DFCComSendInfotext@16
DFCComSendInfotext
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | text | Zeichenfolge mit dem anzuzeigenden Text. |
[in] | textLength | Länge des anzuzeigenden Textes. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCComSendMessage | ( | int | connectionNumber, |
int | deviceAddress, | ||
unsigned char | visibleTime, | ||
unsigned char | doAction, | ||
unsigned char | audibleSignal, | ||
const char * | text, | ||
int | textLength | ||
) |
Sendet eine Meldung ggf. zur Anzeige auf einem Display.
Die Meldung kann zur optischen Quittierung der eingegebenen Benutzerdaten im Onlinebetrieb verwendet werden. Da die Meldung sich in die Bedienung des Gerätes integriert, steht sie maximal bis zur nächsten Eingabe zur Verfügung.
_DFCComSendMessage@28
DFCComSendMessage
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||||||||||||||||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||||||||||||||||||||||||
[in] | visibleTime | Anzeigedauer. (visibleTime * 250ms). 255 -> nicht automatisch wegblenden. | ||||||||||||||||||||||||||||||
[in] | doAction | Ist für Eingriffe in die Bedienung vorgesehen.
| ||||||||||||||||||||||||||||||
[in] | audibleSignal | Meldung aktustisch untermalen.
| ||||||||||||||||||||||||||||||
[in] | text | Zeichenfolge mit dem anzuzeigenden Text. Der Text darf maximal 242 Zeichen lang sein. Durch einfügen von \r in die Zeichenfolge kann ein unterteilen in Zeilen erreicht werden. | ||||||||||||||||||||||||||||||
[in] | textLength | Laenge des anzuzeigenden Textes. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCComSetTime | ( | int | connectionNumber, |
int | deviceAddress, | ||
const unsigned char * | dateTimeBuffer | ||
) |
Setzt das übergebene Datum und die Uhrzeit in dem Gerät.
Wird an dateTimeBuffer ein nullptr übergeben, wird die aktuelle Systemzeit verwendet. Ansonsten muss das zuvor aufbereitete Datum mit Uhrzeit in einem Datenarray vorliegen.
_DFCComSetTime@12
DFCComSetTime
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | dateTimeBuffer | Datenarray mit Werten für Datum und Uhrzeit oder ein nullptr wobei dann die aktuelle Systemzeit verwendet wird. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCGetDeviceId | ( | int | connectionNumber, |
int | deviceAddress, | ||
int * | value | ||
) |
Lesen einer eindeutigen Geräte-Id, alternativ zur Seriennummer und dem Gerätetypen.
DFCGetDeviceId
DFCGetDeviceId
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[out] | value | Id. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCGetDevicePollRetry | ( | int | connectionNumber | ) |
Abfrage der zuletzt mit DFCCheckDevice() benötigten Anzahl Versuche.
Die Anzahl der benötigten Versuche können für eventuelle Statistikzwecke verwendet werden. Sie werden nur bei Firmwareversionen kleiner 04.01.00 verwendet.
_DFCGetDevicePollRetry@4
DFCGetDevicePollRetry
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
void DF_API_CALL DFCGetErrorText | ( | int | connectionNumber, |
int | errorNumber, | ||
int | languageId, | ||
char * | value, | ||
int | valueLength | ||
) |
Auflösen einer Fehlernummer in seine Textentsprechung.
Die von den meisten Funktionen über den Parameter errorNumber zurückgegebene Fehlernummer oder mittels DFCGetLastErrorNumber() ermittelte, kann mit dieser Funktion in seine lesbare Bedeutung umgewandelt werden.
_DFCGetErrorText@20
DFCGetErrorText
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | errorNumber | Fehlernummer, die den Fehlercode des letzten Funktionsaufrufs enthält. Siehe auch DFCGetLastErrorNumber(). |
[in] | languageId | Angabe der zu verwendenden Sprache. Standardwert und aktuell einziger möglicher ist 0 = Deutsch. |
[out] | value | Zeichenarray für den Fehlertext. |
[in] | valueLength | Länge des Zeichenarrays value. |
int DF_API_CALL DFCGetGlobVar | ( | int | connectionNumber, |
int | deviceAddress, | ||
const char * | name, | ||
int | nameType, | ||
char * | value, | ||
int | valueLength, | ||
int * | errorNumber | ||
) |
Lesen des Wertes einer Setup- oder Systemvariablen.
Die im Setup vorhandenen globalen Variablen oder im System veränderbare Variablen können über diese Funktion gelesen werden.
_DFCGetGlobVar@28
DFCGetGlobVar
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||
[in] | name | Zeichenfolge mit dem Namen der Variablen. Oder im ersten Byte der Zeichenfolge steht der Index der anzusprechenden Setupvariablen. | ||||||||
[in] | nameType | Gibt an ob name auf eine Zeichenfolge für den Namen einer Setup- oder Systemvariablen verweist oder ob es sich um ein Indexbyte einer Setupvariablen handelt.
| ||||||||
[out] | value | Zeichenarray für den Wert.
| ||||||||
[in] | valueLength | Länge des Zeichenarrays value. | ||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCGetInfo | ( | int | connectionNumber, |
int | deviceAddress, | ||
const char * | name, | ||
const char * | params, | ||
char * | text, | ||
int * | textLength, | ||
int * | errorNumber | ||
) |
Lesen der Information eines bestimmten Moduls.
Die zurückgelieferte Information liegt in einer Zeichenfolge vor, die je nach abgefragtem Modul verschiedene Informationen enthalten kann. Diese Informationszeichenfolge muss für die weitere Verarbeitung ggf. in ihre Bestandteile zerlegt werden, wozu alle einzelnen Informationsteile durch ein CR (dezimal 13) Zeichen voneinander getrennt werden. Bitte beachten Sie auch, dass sich der Name aus zwei Bestandteilen zusammensetzt, zum einen aus Bereichsbezeichner wie ACCESS um das Zutrittsmodul anzusprechen und zum zweiten aus der Bezeichnung der anzusprechenden "Komponente" in diesem Bereich.
Möchten Sie z. B. die Information zum angeschlossenen Stichleser am Türmodul mit der Busnummer 2 abrufen, benötigen Sie zum einen den "name" "ACCESS.MODULE\0" und die zugehörige "params" Parameterliste "021\0". Nach erfolgreicher Ausführung der Funktion stehen Ihnen die gelieferten Informationen in der Zeichenkette auf die "info" verweist zur Verfügung. (Das Zeichen '\0' stellt die Nullterminierung der Zeichenfolge dar.)
_DFCGetInfo@28
DFCGetInfo
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||||||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||||||||||||||
[in] | name | Name der abzurufenden Information. (z.B. "ACCESS.MODULE") Der Name setzt sich aus zwei Bestandteilen zusammen die mit einem Punkt miteinander verbunden werden. Der erste Teil gibt den Bereich an und kann folgende Zeichenfolge sein:
| ||||||||||||||||||||
[in] | params | Zeiger auf die ggf. anzugebende Parameterliste als Zeichenfolge. Die einzelnen Parameter müssen durch ein CR (dezimal 13) voneinander getrennt werden. Die anzugebende Parameterliste setzt sich für die entsprechenden Namen folgendermaßen zusammen:
| ||||||||||||||||||||
[out] | text | Zeichenarray für den Informationsstring. Die einzelnen Teilangaben sind mit dem Steuerzeichen CR ('\r') voneinander getrennt. Der Informationsstring für ACCESS.MODULE gliedert sich wie folgt.
| ||||||||||||||||||||
[in,out] | textLength | Als in die Länge des Puffers text, als out die Länge der übergebenen Zeichenfolge. | ||||||||||||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCGetLastErrorNumber | ( | int | connectionNumber, |
int | deviceAddress | ||
) |
Liefert die Fehlernummer welche zuletzt aufgetreten ist.
DFCGetLastErrorNumber
DFCGetLastErrorNumber
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
int DF_API_CALL DFCGetOptionFirmware | ( | int | connectionNumber, |
int | deviceAddress, | ||
int * | mask, | ||
int * | options, | ||
int * | errorNumber | ||
) |
Liest die Werte der Zusatzoptionen zur Firmware.
Über die Optionen wird zum einen gesteuern was die Firmware an Funktionalitäten unterstützten soll. Zum anderen wird über die Optionen ein gewisses Verhalten vorgegeben.
_DFCGetOptionFirmware@20
DFCGetOptionFirmware
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||||||||||||||||||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||||||||||||||||||||||||||
[out] | mask | Wert der angesprochenen Optionen.
options zur Verfügung stehen. | |||||||||||||||||||||||||||||||||
[out] | options | Aktueller Zustand der Option.
// Bitnummer 9 entspricht Wert 256 oder 0x100 hex.
if ( (mask & 0x100) == 0x100 )
{
if ( (options & 0x100) == 0x100 )
{
// Option "Setup und Listen beibehalten" aktiv.
}
else
{
// Option "Setup und Listen beibehalten" inaktiv.
}
}
else
{
// Option nicht verfügbar.
}
| |||||||||||||||||||||||||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCGetRelayState | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | number, | ||
int * | state, | ||
int * | timeout, | ||
int * | errorNumber | ||
) |
Abfragen des aktuellen Zustandes und der verbleibenden Zeit eines geschalteten Ausgangs (Relais).
Der aktuelle Zustand und die verbleibende Zeit des geschlossenen Ausgangs wird abgefragt.
_DFCGetRelayState@24
DFCGetRelayState
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | number | Nummer des Ausgangs. Bereich 0 bis 40. |
[out] | state | Zeiger auf eine Variable, welche den aktuellen Schaltzustand des Ausgangs erhaelt. |
[out] | timeout | Zeiger auf die Variable, welche die verbleibende Zeit in Sekunden erhaelt. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCGetSeriennummer | ( | int | connectionNumber, |
int | deviceAddress, | ||
int * | errorNumber, | ||
int * | value | ||
) |
Die Seriennummer des Gerätes auslesen.
_DFCGetSeriennummer@16
DFCGetSeriennummer
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
[out] | value | Seriennummer. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCGetVersionFirmware | ( | int | connectionNumber, |
int | deviceAddress, | ||
char * | value, | ||
int * | errorNumber | ||
) |
Liefert die im Gerät befindliche Firmwareversion und den Namenskürzel.
_DFCGetVersionFirmware@16
DFCGetVersionFirmware
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[out] | value | Zeichenpuffer für die Firmwareversion. Mindestgröße 64 Byte.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCOpenRelay | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | number, | ||
int * | errorNumber | ||
) |
Öffnen eines Ausgangs (Relais).
Internen digitalen Ausgang oder externen digitalen Ausgang (z.B. IO-Module) schalten.
_DFCOpenRelay@16
DFCOpenRelay
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | deviceAddress | Anzusprechende Geräteadresse. |
[in] | number | Nummer des Ausgangs. Bereich 0 bis 40. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCPressVirtualKey | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | keyCode, | ||
int | flags, | ||
int * | errorNumber | ||
) |
Über diese Funktion können Sie einen Tastendruck auslösen.
Über diese Funktion können Sie einen Tastendruck auslösen. Sie können somit per DLL-Befehl zwischen den verschiedenen Funktionstasten umschalten. Es ist über diesen Befehl möglich, Tasten anzusprechen die nicht direkt auf der Tastatur verfügbar sind z. B. F6 - F15 beim PZE-MasterIV.
_DFCPressVirtualKey@20
DFCPressVirtualKey
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||||||||||||||||||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||||||||||||||||||||||||||
[in] | keyCode | Gibt den Tastencode an.
| ||||||||||||||||||||||||||||||||
[in] | flags | Gibt zusatzliche Bedeutungen zum Tastendruck an:
| ||||||||||||||||||||||||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
DF_API_EXTERN int DF_API_CALL DFCReadDataBlock | ( | int | connectionNumber, |
int | deviceAddress, | ||
const char * | name, | ||
char * | data, | ||
int * | length, | ||
int | flags | ||
) |
Lesen eines Datenblocks. Dieses kann der Wert einer Systemvariablen oder der Inhalt einer Datei sein.
Diese Funktion soll die Einschränkungen der Funktionen DFCGetGlobVar() und DFCFileDownload() aufheben und beide vereinen. Die Funktion DFCGetGlobVar() hat die Einschränkung einer maximal mögliche Länge des Wertes und die Funktion DFCFileDownload() bietet nicht die Möglichkeit die Daten der Datei in einem Datenpuffer zu erhalten.
DFCReadDataBlock
DFCReadDataBlock
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||
[in] | name | Der Name des zu lesenden Datenblocks. Dieses kann der Name einer Systemvariablen oder mit '/' beginnend, der Name einer Datei sein. | |||||||||
[out] | data | Zeiger auf den Datenpuffer der die Daten erhält. Bei Verwendung des flags 1 wird hier ggf. der Dateiname abgelegt. | |||||||||
[in,out] | length | Als in die reservierte Länge des auf data zeigenden Datenarrays, als out die nach data geschriebene Anzahl Bytes. | |||||||||
[in] | flags | Flagfeld mit folgenden Bedeutungen.
|
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich, Daten liegen in data vor. |
2 | Ausführung war erfolgreich, data beinhaltet den Namen der temporär erzeugten Datei mit dem Dateninhalt. |
int DF_API_CALL DFCRecordVolume | ( | int | connectionNumber, |
int | deviceAddress, | ||
int * | recordCount, | ||
int * | memoryUsage, | ||
int * | memorySize, | ||
int * | errorNumber | ||
) |
int DF_API_CALL DFCReset | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | mode, | ||
int * | errorNumber | ||
) |
Reset je nach gewähltem Modus durchführen.
Reset je nach gewähltem Modus durchführen. Das Geräte macht nach der Ausführung einen Neustart.
_DFCReset@16
DFCReset
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||||
[in] | mode | Modus, welche angibt was zurückgesetzt wird.
| ||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
void DF_API_CALL DFCSetCallBack | ( | int | connectionNumber, |
int(*)(void) | functionPointer | ||
) |
Setzen einer Rückruffunktion.
Die Rückruffunktion wird während des Kommunikationsablaufs fortwährend aufgerufen und bietet die Möglichkeit eines Abbruches der Befehlsausführung.
_DFCSetCallBack@8
DFCSetCallBack
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | functionPointer | Zeiger auf die Rückruffunktion oder nullptr für abschalten. Gibt die Funktion eine 1 zurück wird mit der Kommunikation fortgefahren, bei Rückgabe einer 0 wird mit einem entsprechenden Fehler die Befehlsausführung abgebrochen. |
int DF_API_CALL DFCSetCommunicationPassword | ( | int | connectionNumber, |
const char * | value, | ||
int | valueLength, | ||
int | sessionTimeout, | ||
int * | errorNumber | ||
) |
Setzen des zu verwendenden Verschlüsselungspasswortes der Kommunikation.
Setzen des zu verwendenden Verschlüsselungspasswortes der Kommunikation. Das Passwort wird für die Verschlüsselte Kommuniation verwendet und muss ebenfalls im Gerät hinterlegt sein. Siehe Systemvariable COM.KEY. Je nach Angabe des sessionTimeouts wird eine Neuaushandlung eines Sessionkeys vorgenommen.
_DFCSetCommunicationPassword@20
DFCSetCommunicationPassword
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | value | Zeichenfolge des Passwortes. Maximal 16 Zeichen. |
[in] | valueLength | Länge des in value stehenden Passwortes. |
[in] | sessionTimeout | Gibt einen Timeout an, nachdem der ausgehandelte Session-Key seine Gültigkeit verliert und eine Neuaushandlung notwendig macht. Einheit ist Sekunden, bei Verwendung von 0 wird keine Neuaushandlung durchgeführt. Wertebereich (0, 60 - 100000). |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCSetFontType | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | type, | ||
int * | errorNumber | ||
) |
Setzt den zu verwendenden Schrifttyp zur Darstellung der Nachrichten.
Setzt den zu verwendenden Schrifttyp zur Darstellung der Nachrichten bei DFCComSendMessage() oder DFCComSendInfotext(). Bei den Nachrichten wird der zuvor gewählte Schrifttyp bis zum Neustart des Gerätes beibehalten. Sie können unterschiedliche Schrifttypen verwenden, wenn Sie jeweils vor SendMessage und SendInfotext einen entsprechenden Schrifttyp einstellen.
_DFCSetFontType@16
DFCSetFontType
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||||||||||
[in] | type | Typ der zu vewendenden Schriftart.
| ||||||||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCSetGlobVar | ( | int | connectionNumber, |
int | deviceAddress, | ||
const char * | name, | ||
int | nameType, | ||
const char * | value, | ||
int * | errorNumber | ||
) |
Setzen des Wertes einer Setup- oder Systemvariablen.
Die im Setup vorhandenen globalen Variablen oder im System veränderbare Variablen können über diese Funktion geändert werden.
_DFCSetGlobVar@24
DFCSetGlobVar
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | ||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | ||||||||
[in] | name | Zeichenfolge mit dem Namen der Variablen. Oder im ersten Byte der Zeichenfolge steht der Index der anzusprechenden Setupvariablen. | ||||||||
[in] | nameType | Gibt an ob name auf eine Zeichenfolge für den Namen einer Setup- oder Systemvariablen verweist oder ob es sich um ein Indexbyte einer Setupvariablen handelt.
| ||||||||
[in] | value | Zeichenfolge mit dem zu setzenden Wert.
| ||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCSetOptionFirmware | ( | int | connectionNumber, |
int | deviceAddress, | ||
int | mask, | ||
int | options, | ||
int * | errorNumber | ||
) |
Setzt benötigte Zusatzoptionen der Firmware.
Über die Optionen können Sie zum einen Steuern was die Firmware an Funktionalitäten unterstützten soll. Hierbei wird vor der Übertragung einer Firmwaredatei geprüft ob die benötigten Funktionen durch diese unterstützt werden. Zum anderen geben Sie über die Optionen ein gewisses Verhalten vor. Hierdurch können Sie zum Beispiel angeben, dass ein bestehendes Setup und die Listen nach einem Firmwareupdate beibehalten werden sollen.
_DFCSetOptionFirmware@20
DFCSetOptionFirmware
[in] | connectionNumber | Zu verwendende Verbindungsnummer. | |||||||||||||||||||||||||||||||||
[in] | deviceAddress | Anzusprechende Geräteadresse. | |||||||||||||||||||||||||||||||||
[in] | mask | Maske of the options to be accessed.
Als Beispiel geben Sie für das Ansprechen der Optionen "Transpondermenü" und "Setup und Listen beibehalten" (16 + 256 =) 272 als Wert an. | |||||||||||||||||||||||||||||||||
[in] | options | Anzunehmender Zustand der gewählten Option.
| |||||||||||||||||||||||||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCSetPassword | ( | int | connectionNumber, |
const char * | value, | ||
int * | errorNumber | ||
) |
Setzen des zu verwendenden Setuppasswortes für diese Verbindung.
Setzen des zu verwendenden Setuppasswortes für diese Verbindung. Das Passwort wird der Firmware, bei Aufforderung mitgeteilt. Es wird über die Setupdaten in das Gerät übertragen und muss nach der erfolgeichen Übertragung durch diese Routine der Bibliothek mitgeteilt werden.
_DFCSetPassword@12
DFCSetPassword
[in] | connectionNumber | Zu verwendende Verbindungsnummer. |
[in] | value | Zeichenfolge des Passworts. Maximal 16 Zeichen. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCVersionLibrary | ( | char * | value, |
int | valueLength | ||
) |
Ermitteln der Libraryversion.
Die Version wird im Format XX.XX.XX.XX geliefert.
_DFCVersionLibrary@8
DFCVersionLibrary
[out] | value | Zeiger auf Zeichenfolgenpuffer für die Version. |
[in] | valueLength | Länge des reservierten Puffers für die Zeichenfolge. Muss mindestens 12 sein. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |