Datafox DFCom - API  04.03.11.00
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
df_api.h-Dateireferenz
#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 connectionId, int deviceAddress)
 Prüft ob das Gerät erreichbar ist. Mehr ...
 
int DF_API_CALL DFCCheckDevice (int connectionId, int deviceAddress, int *errorNumber, int devicePollRetry)
 Prüft ob das Gerät erreichbar ist. Mehr ...
 
int DF_API_CALL DFCComSetTime (int connectionId, int deviceAddress, const unsigned char *dateTimeBuffer)
 Setzt das übergebene Datum und die Uhrzeit in dem Gerät. Mehr ...
 
int DF_API_CALL DFCComGetTime (int connectionId, int deviceAddress, unsigned char *dateTimeBuffer)
 Liest das Datum und die Uhrzeit aus dem Gerät. Mehr ...
 
int DF_API_CALL DFCComSendMessage (int connectionId, 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. Mehr ...
 
int DF_API_CALL DFCComSendInfotext (int connectionId, int deviceAddress, const char *text, int textLength)
 Sendet eine Memonachricht an Geräte. Mehr ...
 
int DF_API_CALL DFCGetSeriennummer (int connectionId, int deviceAddress, int *errorNumber, int *value)
 Die Seriennummer des Gerätes auslesen. Mehr ...
 
void DF_API_CALL DFCSetCallBack (int connectionId, int(*functionPointer)(void))
 Setzen einer Rückruffunktion. Mehr ...
 
void DF_API_CALL DFCGetErrorText (int connectionId, int errorNumber, int languageId, char *value, int valueLength)
 Auflösen einer Fehlernummer in seine Textentsprechung. Mehr ...
 
int DF_API_CALL DFCSetGlobVar (int connectionId, int deviceAddress, const char *name, int nameType, const char *value, int *errorNumber)
 Setzen des Wertes einer Setup- oder Systemvariablen. Mehr ...
 
int DF_API_CALL DFCGetGlobVar (int connectionId, int deviceAddress, const char *name, int nameType, char *value, int valueLength, int *errorNumber)
 Lesen des Wertes einer Setup- oder Systemvariablen. Mehr ...
 
int DF_API_CALL DFCCloseRelay (int connectionId, int deviceAddress, int number, int timeout, int *errorNumber)
 Schliessen eines Ausgangs (Relais). Mehr ...
 
int DF_API_CALL DFCGetRelayState (int connectionId, int deviceAddress, int number, int *state, int *timeout, int *errorNumber)
 Abfragen des aktuellen Zustandes und der verbleibenden Zeit eines geschalteten Ausgangs (Relais). Mehr ...
 
int DF_API_CALL DFCOpenRelay (int connectionId, int deviceAddress, int number, int *errorNumber)
 Öffnen eines Ausgangs (Relais). Mehr ...
 
int DF_API_CALL DFCGetDevicePollRetry (int connectionId)
 Abfrage der zuletzt mit DFCCheckDevice() benötigten Anzahl Versuche. Mehr ...
 
int DF_API_CALL DFCGetVersionFirmware (int connectionId, int deviceAddress, char *value, int *errorNumber)
 Liefert die im Gerät befindliche Firmwareversion und den Namenskürzel. Mehr ...
 
int DF_API_CALL DFCSetFontType (int connectionId, int deviceAddress, int type, int *errorNumber)
 Setzt den zu verwendenden Schrifttyp zur Darstellung der Nachrichten. Mehr ...
 
int DF_API_CALL DFCPressVirtualKey (int connectionId, int deviceAddress, int keyCode, int flags, int *errorNumber)
 Über diese Funktion können Sie einen Tastendruck auslösen. Mehr ...
 
int DF_API_CALL DFCSetPassword (int connectionId, const char *value, int *errorNumber)
 Setzen des zu verwendenden Setuppasswortes für diese Verbindung. Mehr ...
 
int DF_API_CALL DFCReset (int connectionId, int deviceAddress, int mode, int *errorNumber)
 Reset je nach gewähltem Modus durchführen. Mehr ...
 
int DF_API_CALL DFCSetCommunicationPassword (int connectionId, const char *value, int valueLength, int sessionTimeout, int *errorNumber)
 Setzen des zu verwendenden Verschlüsselungspasswortes der Kommunikation. Mehr ...
 
DFComDLL als c _DFCRecordVolume n DFCom_x64 als c DFCRecordVolume int DF_API_CALL DFCRecordVolume (int connectionId, int deviceAddress, int *recordCount, int *memoryUsage, int *memorySize, int *errorNumber)
 
int DF_API_CALL DFCGetInfo (int connectionId, int deviceAddress, const char *name, const char *params, char *text, int *textLength, int *errorNumber)
 Lesen der Information eines bestimmten Moduls. Mehr ...
 
int DF_API_CALL DFCVersionLibrary (char *value, int valueLength)
 Ermitteln der Libraryversion. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCGetLastErrorNumber (int connectionId, int deviceAddress)
 Liefert die Fehlernummer welche zuletzt aufgetreten ist. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCBlockTransferSetDuration (int connectionId, int deviceAddress, int blockTypesAllowed, int duration)
 Setzt für die entsprechende Geräteadresse oder die gesamte Verbindungs-Id eine Unterbrechungszeit. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCBlockTransferResume (int connectionId, int deviceAddress)
 Setzt eine bestehende Blockübertragung fort. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCBlockTransferGetState (int connectionId, int deviceAddress, int *currentType, int *currentState)
 Ruft den Typen und Zustand der ggf. vorhandenen Blockübertragung ab. Mehr ...
 
DF_API_EXTERN int DF_API_CALL DFCBlockTransferDiscard (int connectionId, int deviceAddress)
 Verwirft eine aktuell laufende Blockübertragung. Die bis dahin übertragenen Daten werden verforfen. Mehr ...
 

Dokumentation der Funktionen

◆ DFCBlockTransferDiscard()

DF_API_EXTERN int DF_API_CALL DFCBlockTransferDiscard ( int  connectionId,
int  deviceAddress 
)

Verwirft eine aktuell laufende Blockübertragung. Die bis dahin übertragenen Daten werden verforfen.

Export
DFComDLL als DFCBlockTransferDiscard
DFCom_x64 als DFCBlockTransferDiscard
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.03.08 enthalten.

◆ DFCBlockTransferGetState()

DF_API_EXTERN int DF_API_CALL DFCBlockTransferGetState ( int  connectionId,
int  deviceAddress,
int *  currentType,
int *  currentState 
)

Ruft den Typen und Zustand der ggf. vorhandenen Blockübertragung ab.

Export
DFComDLL als DFCBlockTransferGetState
DFCom_x64 als DFCBlockTransferGetState
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]currentTypeAktueller Blocktyp. Bei 0 ist keine Blockübertragung aktiv.
BitnummerWertBedeutung
11Setuplisten, unterbricht DFCLoadListen().
22Zutrittslisten, unterbricht DFCLoadEntrance2List().
[out]currentStateAktueller Zustand.
WertBedeutung
0Keine unterbrochene Blockübertragung aktiv.
2Die durch currentType angegebene Blockübertragung wartet auf ihre Fortsetzung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.03.08 enthalten.

◆ DFCBlockTransferResume()

DF_API_EXTERN int DF_API_CALL DFCBlockTransferResume ( int  connectionId,
int  deviceAddress 
)

Setzt eine bestehende Blockübertragung fort.

Export
DFComDLL als DFCBlockTransferResume
DFCom_x64 als DFCBlockTransferResume
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.03.08 enthalten.

◆ DFCBlockTransferSetDuration()

DF_API_EXTERN int DF_API_CALL DFCBlockTransferSetDuration ( int  connectionId,
int  deviceAddress,
int  blockTypesAllowed,
int  duration 
)

Setzt für die entsprechende Geräteadresse oder die gesamte Verbindungs-Id eine Unterbrechungszeit.

Export
DFComDLL als DFCBlockTransferSetDuration
DFCom_x64 als DFCBlockTransferSetDuration
Zu beachten
Der Blocktransfer ist für die Funktionen DFCLoadListen() und DFCLoadEntrance2List() nutzbar.
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]blockTypesAllowedGibt an welche Blockübertragungen.
BitnummerWertBedeutung
11Setuplisten, unterbricht DFCLoadListen().
22Zutrittslisten, unterbricht DFCLoadEntrance2List().
Durch ein Aufaddieren dieser Werte können Sie bestimmen welche Datenblöcke durch die angegebene Zeit unterbrochen werden sollen. Möchten Sie z. B. die Setup- und Zutrittslisten mit Unterbrechungen übertragen übergeben Sie eine 3.
[in]durationZeitangabe 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.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.03.08 enthalten.

◆ DFCCheckAE()

int DF_API_CALL DFCCheckAE ( int  connectionId,
int  deviceAddress 
)

Prüft ob das Gerät erreichbar ist.

Prüft durch Abruf der Firmwareversion die Erreichbarkeit des Gerätes.

Export
DFComDLL als _DFCCheckAE@8
DFCom_x64 als DFCCheckAE
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
Rückgabewerte
0Nicht Erreichbar. Gerät antwortete nicht auf die Anfragen.
1Erreichbar.

◆ DFCCheckDevice()

int DF_API_CALL DFCCheckDevice ( int  connectionId,
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.

Export
DFComDLL als _DFCCheckDevice@16
DFCom_x64 als DFCCheckDevice
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
[in]devicePollRetryAnzahl 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.
Rückgabewerte
0Nicht Erreichbar. Gerät antwortete nicht auf die Anfragen.
1Erreichbar.

◆ DFCCloseRelay()

int DF_API_CALL DFCCloseRelay ( int  connectionId,
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.

Export
DFComDLL als _DFCCloseRelay@20
DFCom_x64 als DFCCloseRelay
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]numberNummer des Ausgangs.
[in]timeoutZeit in Sekunden, für welche der Ausgang geschaltet wird.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCComGetTime()

int DF_API_CALL DFCComGetTime ( int  connectionId,
int  deviceAddress,
unsigned char *  dateTimeBuffer 
)

Liest das Datum und die Uhrzeit aus dem Gerät.

Das Datum mit Uhrzeit wird in einen Datenarray abgelegt.

Export
DFComDLL als _DFCComGetTime@12
DFCom_x64 als DFCComGetTime
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]dateTimeBufferDatenarray für die Werte von Datum und Uhrzeit.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCComSendInfotext()

int DF_API_CALL DFCComSendInfotext ( int  connectionId,
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.

Export
DFComDLL als _DFCComSendInfotext@16
DFCom_x64 als DFCComSendInfotext
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]textZeichenfolge mit dem anzuzeigenden Text.
[in]textLengthLänge des anzuzeigenden Textes.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCComSendMessage()

int DF_API_CALL DFCComSendMessage ( int  connectionId,
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.

Export
DFComDLL als _DFCComSendMessage@28
DFCom_x64 als DFCComSendMessage
Zu beachten
Bei Verwendung der Setupoption "Server online" nuss nach dem Abruf eine Online-Datensatzes dieser mit einer Meldung quittiert werden, ansonsten bekommt der Anwender am Terminal eine Feldermeldung angezeigt. Sie können auch eine Dummy-Meldung mit der Anzeigedauer von 0 senden um eine Freischaltung der Bedinung zu erreichen wobei keine Meldung am Display angezeigt wird..
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]visibleTimeAnzeigedauer. (visibleTime * 250ms). 255 -> nicht automatisch wegblenden.
[in]doActionIst für Eingriffe in die Bedienung vorgesehen.
WertBedeutung
0Nachricht, wenn möglich anzeigen.
1Nachricht enthält zusätzliche Steuerdaten.
[in]audibleSignalMeldung aktustisch untermalen.
SymbolBedeutung
+50 ms Ton an
-50 ms Ton aus
WertBedeutung
0- Off
1++++++++ Ok
2+++++--—+++++ Error
3+++++
4++–+++++
5++–++
6+++++–+++++
7++–++–++
8+++++–+++++–+++++
9++–+++++–++
10+++++–++–+++++
[in]textZeichenfolge 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]textLengthLaenge des anzuzeigenden Textes.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCComSetTime()

int DF_API_CALL DFCComSetTime ( int  connectionId,
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.

Export
DFComDLL als _DFCComSetTime@12
DFCom_x64 als DFCComSetTime
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]dateTimeBufferDatenarray mit Werten für Datum und Uhrzeit oder ein nullptr wobei dann die aktuelle Systemzeit verwendet wird.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCGetDevicePollRetry()

int DF_API_CALL DFCGetDevicePollRetry ( int  connectionId)

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.

Export
DFComDLL als _DFCGetDevicePollRetry@4
DFCom_x64 als DFCGetDevicePollRetry
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
Rückgabe
Anzahl der benötigten Versuche bis Gerät als verfügbar galt.

◆ DFCGetErrorText()

void DF_API_CALL DFCGetErrorText ( int  connectionId,
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.

Export
DFComDLL als _DFCGetErrorText@20
DFCom_x64 als DFCGetErrorText
Zu beachten
Die hier gelieferte Textentprechung ist nicht für die Anzeige bei Ihren Kunden vorgesehen. Bitte beachten Sie, dass bei Ihren Kunden eigene Fehlermeldungen bei Kommunikationsstörungen angezeigt werden. Die Fehlermeldungen der Kommunikationsbibliothek sind allgemein gehalten und zumeist nur im Einzelbefehlskontext sinnvoll zu verstehen.
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[out]errorNumberFehlernummer die nach Fehlern den letzten Fehlercode enthält. Siehe auch DFCGetLastErrorNumber().
[in]languageIdAngabe der zu verwendenden Sprache. Standardwert und aktuell einziger möglicher ist 0 = Deutsch.
[out]valueZeichenarray für den Fehlertext.
[in]valueLengthLänge des Zeichenarrays value.

◆ DFCGetGlobVar()

int DF_API_CALL DFCGetGlobVar ( int  connectionId,
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.

Export
DFComDLL als _DFCGetGlobVar@28
DFCom_x64 als DFCGetGlobVar
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]nameZeichenfolge mit dem Namen der Variablen. Oder im ersten Byte der Zeichenfolge steht der Index der anzusprechenden Setupvariablen.
[in]nameTypeGibt 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.
WertBedeutung
0name zeigt auf ein Indexbyte. Der gültige Wertebereich ist 1 - 8.
1name zeigt auf eine Zeichenfolge mit dem Namen einer Setupvariablen. Maximal 16 Zeichen.
2name zeigt auf eine Zeichenfolge mit dem Namen einer Systemvariablen.
[out]valueZeichenarray für den Wert.
WertBedeutung
nameType = 0 oder 1Bis Firmware Version 04.03.00 maximal 20 Zeichen, danach maximal 60 Zeichen.
nameType = 2Die mögliche Länge ist abhängig von der Systemvariablen.
[in]valueLengthLänge des Zeichenarrays value.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCGetInfo()

int DF_API_CALL DFCGetInfo ( int  connectionId,
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.)

Export
DFComDLL als _DFCGetInfo@28
DFCom_x64 als DFCGetInfo
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]nameName 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:
BereichBedeutung
ACCESSfür Zutritt
FINGERPRINTfür Fingerprint
USBHOSTfür USB-Host
der zweite Teil gibt den Namen der anzusprechenden Komponende an, und kann folgende Zeichenfolgen sein:
BereichKomponendeBedeutung
ACCESSMODULEZutrittsmodul / -leser
FINGERPRINTMODULEFingerprintmodul Firmwareversion
USBHOSTMODULEUSB-Host Firmwareversion (z.B. "3.62-000VDAP")
[in]paramsZeiger 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:
BereichParameterBedeutung
ACCESS.MODULE1Türmodulnummer gemäß der Spalte "TM" der Zutrittsliste "Reader". Der Wert muss immer 3 Ziffern umfassen. Genauere Angaben hierzu finden sie im Handbuch im Kapitel "Zutrittskontrolle 2".
ACCESS.MODULE2Optional die Bus-Id bei Systemen mit mehreren Zutrittsbussen. Bei fehlen, wird der erste Bus angenommen.
FINGERPRINT.MODULE1Leer
USBHOST.MODULE1Leer
[out]textZeichenarray 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.
WertKomponendeBedeutung
Status1Gibt den aktuellen Status des Moduls zurück. Genauere Angaben hierzu finden sie im Handbuch im Unterkapitel "Statusmeldungen der Zutrittskontrolle" der Zutrittskontrolle 2.
Name2Gibt die Bezeichnung des angesprochenen Moduls zurück.
Firmwareversion3Gibt die Firmwareversion des angesprochenen Moduls zurück.
[in,out]textLengthAls in die Länge des Puffers text, als out die Länge der übergebenen Zeichenfolge.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.01.04 enthalten.

◆ DFCGetLastErrorNumber()

DF_API_EXTERN int DF_API_CALL DFCGetLastErrorNumber ( int  connectionId,
int  deviceAddress 
)

Liefert die Fehlernummer welche zuletzt aufgetreten ist.

Export
DFComDLL als DFCGetLastErrorNumber
DFCom_x64 als DFCGetLastErrorNumber
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
Rückgabe
Fehlernummer. Siehe Tabelle der Fehlernummern.
Seit
04.03.08 enthalten

◆ DFCGetRelayState()

int DF_API_CALL DFCGetRelayState ( int  connectionId,
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.

Export
DFComDLL als _DFCGetRelayState@24
DFCom_x64 als DFCGetRelayState
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]numberNummer des Ausgangs.
[out]stateZeiger auf eine Variable, welche den aktuellen Schaltzustand des Ausgangs erhaelt.
[out]timeoutZeiger auf die Variable, welche die verbleibende Zeit in Sekunden erhaelt.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCGetSeriennummer()

int DF_API_CALL DFCGetSeriennummer ( int  connectionId,
int  deviceAddress,
int *  errorNumber,
int *  value 
)

Die Seriennummer des Gerätes auslesen.

Export
DFComDLL als _DFCGetSeriennummer@16
DFCom_x64 als DFCGetSeriennummer
Zu beachten
Um eine eindeutige Geräte-Id des Datafox-Gerätes zu erhalten wird zusätzliche zu der Seriennummer noch der Gerätetyp benötigt. Bei Datafox sind die Seriennummernkreise an den Gerätetyp gebunden. Es können somit unterschiedliche Gerätetypen mit den selben Seriennummern in Ihrem System auftreten.
Den Gerätetypen können Sie beispielsweise über den Namenskürzel der Firmwareversion per DFCGetVersionFirmware() ermitteln.
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
[out]valueSeriennummer.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCGetVersionFirmware()

int DF_API_CALL DFCGetVersionFirmware ( int  connectionId,
int  deviceAddress,
char *  value,
int *  errorNumber 
)

Liefert die im Gerät befindliche Firmwareversion und den Namenskürzel.

Export
DFComDLL als _DFCGetVersionFirmware@16
DFCom_x64 als DFCGetVersionFirmware
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[out]valueZeichenpuffer für die Firmwareversion. Mindestgröße 64 Byte.
GerätenummerNameKürzel
255Unbekannter Gerätetyp
0PZE-MasterIVPZE
1ZK-MasterIVZK
2BDE-MasterIVBDE
3Mobil-MasterIVMOBIL
4MDE-BoxIVMDE
5AE-MasterIVAE
6TimeboyIVTIMEBOY
7Exklusiv-Line IVEXKLUSIV
8Flex-MasterIVFLEX
9TimeboyIV Mobil-PZETB-MOBIL-PZE
10EVO 2.8Evo28
11EVO 4.3Evo43
12IPC Embedded-SystemVARIO
13IPC Embedded-SystemIPC
14IPC Embedded-SystemQ7
15IO-Box V4IOBOX
16ZK-Box V4ZKBOX
17Mobil-Box V4MOBILBOX
18Dockingstation V2DockingV2
19Fahrzeugdatenlogger V2LoggerV2
20ZK-KnotenZKKNOTEN
21EVO 3.5 UniversalEVO_3_5_UNIVERSAL
22SAMS-OCL-ReaderSAMS-OCL
23EVO 3.5EVO35
24ZK-Leser PlusZKREADERPLUS
24ZK-Leser PlusZKZENTRALE
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCOpenRelay()

int DF_API_CALL DFCOpenRelay ( int  connectionId,
int  deviceAddress,
int  number,
int *  errorNumber 
)

Öffnen eines Ausgangs (Relais).

Internen digitalen Ausgang oder externen digitalen Ausgang (z.B. IO-Module) schalten.

Export
DFComDLL als _DFCOpenRelay@16
DFCom_x64 als DFCOpenRelay
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]numberNummer des Ausgangs.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCPressVirtualKey()

int DF_API_CALL DFCPressVirtualKey ( int  connectionId,
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.

Export
DFComDLL als _DFCPressVirtualKey@20
DFCom_x64 als DFCPressVirtualKey
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]keyCodeGibt den Tastencode an.
WertBedeutung
112F1 -> Entspricht einem drücken der Funktionstaste 1.
113F2 -> Entspricht einem drücken der Funktionstaste 2.
114F3 -> Entspricht einem drücken der Funktionstaste 3.
115F4 -> Entspricht einem drücken der Funktionstaste 4.
116F5 -> Entspricht einem drücken der Funktionstaste 5.
117F6 -> Entspricht einem drücken der Funktionstaste 6.
118F7 -> Entspricht einem drücken der Funktionstaste 7.
119F8 -> Entspricht einem drücken der Funktionstaste 8.
120F9 -> Entspricht einem drücken der Funktionstaste 9.
121F10 -> Entspricht einem drücken der Funktionstaste 10.
122F11 -> Entspricht einem drücken der Funktionstaste 11.
123F12 -> Entspricht einem drücken der Funktionstaste 12.
124F13 -> Entspricht einem drücken der Funktionstaste 13.
125F14 -> Entspricht einem drücken der Funktionstaste 14.
126F15 -> Entspricht einem drücken der Funktionstaste 15.
[in]flagsGibt zusatzliche Bedeutungen zum Tastendruck an:
BitnummerWertBedeutung
11Wenn Sie dieses Bit setzen, wird der Tastendruck nur ausgeführt, wenn sich das Gerät aktuell im Hauptmenü befindet. Wenn Sie das Bit nicht gesetzt haben, verhält sich das Gerät so als ob eine Person direkt die Taste auf der Tastatur betätigt.
......Reserviert
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.01.07 enthalten.

◆ DFCRecordVolume()

DFComDLL als c _DFCRecordVolume n DFCom_x64 als c DFCRecordVolume int DF_API_CALL DFCRecordVolume ( int  connectionId,
int  deviceAddress,
int *  recordCount,
int *  memoryUsage,
int *  memorySize,
int *  errorNumber 
)

◆ DFCReset()

int DF_API_CALL DFCReset ( int  connectionId,
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.

Export
DFComDLL als _DFCReset@16
DFCom_x64 als DFCReset
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]modeModus, welche angibt was zurückgesetzt wird.
WertBedeutung
1Warmstart des Gerätes.
2Flash Formatieren. (Setup und Listen müssen neu aufgespielt werden!)
3Setup löschen. (Setup und Listen müssen neu aufgespielt werden!)
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.01.07 enthalten.

◆ DFCSetCallBack()

void DF_API_CALL DFCSetCallBack ( int  connectionId,
int(*)(void)  functionPointer 
)

Setzen einer Rückruffunktion.

Die Rückruffunktion wird während des Kommunikationsablaufs fortwährend aufgerufen und bietet die Möglichkeit eines frühzeitigen abbruches der Befehlsausführung.

Export
DFComDLL als _DFCSetCallBack@8
DFCom_x64 als DFCSetCallBack
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]functionPointerZeiger 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.

◆ DFCSetCommunicationPassword()

int DF_API_CALL DFCSetCommunicationPassword ( int  connectionId,
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.

Export
DFComDLL als _DFCSetCommunicationPassword@20
DFCom_x64 als DFCSetCommunicationPassword
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]valueZeichenfolge des Passwortes. Maximal 16 Zeichen.
[in]valueLengthLänge des in value stehenden Passwortes.
[in]sessionTimeoutGibt 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]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.02.03 enthalten.

◆ DFCSetFontType()

int DF_API_CALL DFCSetFontType ( int  connectionId,
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, der zuletzt gesetzte Schrifttyp wird für die Funktion solange beibehalten bis ein Neustart erfolgt.

Export
DFComDLL als _DFCSetFontType@16
DFCom_x64 als DFCSetFontType
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]typeTyp der zu vewendenden Schriftart.
WertBedeutung
0Standardschrift
116 Pixel (7 Anzeigezeilen)
216 Pixel, feste breite (7 Anzeigezeilen)
319 Pixel (6 Anzeigezeilen)
419 Pixel, feste breite (6 Anzeigezeilen)
521 Pixel (5 Anzeigezeilen)
621 Pixel, feste breite (5 Anzeigezeilen)
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.01.07 enthalten.

◆ DFCSetGlobVar()

int DF_API_CALL DFCSetGlobVar ( int  connectionId,
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.

Export
DFComDLL als _DFCSetGlobVar@24
DFCom_x64 als DFCSetGlobVar
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]nameZeichenfolge mit dem Namen der Variablen. Oder im ersten Byte der Zeichenfolge steht der Index der anzusprechenden Setupvariablen.
[in]nameTypeGibt 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.
WertBedeutung
0name zeigt auf ein Indexbyte. Der gültige Wertebereich ist 1 - 8.
1name zeigt auf eine Zeichenfolge mit dem Namen einer Setupvariablen. Maximal 16 Zeichen.
2name zeigt auf eine Zeichenfolge mit dem Namen einer Systemvariablen.
[in]valueZeichenfolge mit dem zu setzenden Wert.
WertBedeutung
nameType = 0 oder 1Bis Firmware Version 04.03.00 maximal 20 Zeichen, danach maximal 60 Zeichen.
nameType = 2Die mögliche Länge ist abhängig von der Systemvariablen.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.

◆ DFCSetPassword()

int DF_API_CALL DFCSetPassword ( int  connectionId,
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.

Export
DFComDLL als _DFCSetPassword@12
DFCom_x64 als DFCSetPassword
Parameter
[in]connectionIdZu verwendende Verbindungs-Id.
[in]valueZeichenfolge des Passworts. Maximal 16 Zeichen.
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.01.07 enthalten.

◆ DFCVersionLibrary()

int DF_API_CALL DFCVersionLibrary ( char *  value,
int  valueLength 
)

Ermitteln der Libraryversion.

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

Export
DFComDLL als _DFCVersionLibrary@8
DFCom_x64 als DFCVersionLibrary
Parameter
[out]valueZeiger auf Zeichenfolgenpuffer für die Version.
[in]valueLengthLänge des reservierten Puffers für die Zeichenfolge. Muss mindestens 12 sein.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.03.00 enthalten

© 2003-2018 Datafox GmbH