#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"

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.

Dokumentation der Funktionen

◆ DFCBlockTransferDiscard()

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.

Export: DFComDLL als DFCBlockTransferDiscard
DFCom_x64 als DFCBlockTransferDiscard

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.03.08 enthalten.

◆ DFCBlockTransferGetState()

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.

Export: DFComDLL als DFCBlockTransferGetState
DFCom_x64 als DFCBlockTransferGetState

Parameter

[in] connectionNumber Zu verwendende Verbindungsnummer.

[in] deviceAddress Anzusprechende Geräteadresse.

[out]

currentType

Aktueller Blocktyp. Bei 0 ist keine Blockübertragung aktiv.

Bitnummer	Wert	Bedeutung
1	1	Setuplisten, unterbricht DFCLoadListen().
2	2	Zutrittslisten, unterbricht DFCLoadEntrance2List().

[out]

currentState

Aktueller Zustand.

Wert	Bedeutung
0	Keine unterbrochene Blockübertragung aktiv.
2	Die durch currentType angegebene Blockübertragung wartet auf ihre Fortsetzung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.03.08 enthalten.

◆ DFCBlockTransferResume()

DF_API_EXTERN int DF_API_CALL DFCBlockTransferResume	(	int	connectionNumber,
		int	deviceAddress
	)

Setzt eine bestehende Blockübertragung fort.

Export: DFComDLL als DFCBlockTransferResume
DFCom_x64 als DFCBlockTransferResume

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.03.08 enthalten.

◆ DFCBlockTransferSetDuration()

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.

Export: DFComDLL als DFCBlockTransferSetDuration
DFCom_x64 als DFCBlockTransferSetDuration

Zu beachten: Der Blocktransfer ist für die Funktionen DFCLoadListen() und DFCLoadEntrance2List() nutzbar.

Parameter

[in] connectionNumber Zu verwendende Verbindungsnummer.

[in] deviceAddress Anzusprechende Geräteadresse.

[in]

blockTypesAllowed

Gibt an welche Blockübertragungen.

Bitnummer	Wert	Bedeutung
1	1	Setuplisten, unterbricht DFCLoadListen().
2	2	Zutrittslisten, 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] 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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.03.08 enthalten.

◆ DFCCheckAE()

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.

Export: DFComDLL als _DFCCheckAE@8
DFCom_x64 als DFCCheckAE

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.

Rückgabewerte

0	Nicht Erreichbar. Gerät antwortete nicht auf die Anfragen.
1	Erreichbar.

◆ DFCCheckDevice()

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.

Export: DFComDLL als _DFCCheckDevice@16
DFCom_x64 als DFCCheckDevice

Parameter

[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.

Rückgabewerte

0	Nicht Erreichbar. Gerät antwortete nicht auf die Anfragen.
1	Erreichbar.

◆ DFCCloseRelay()

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.

Export: DFComDLL als _DFCCloseRelay@20
DFCom_x64 als DFCCloseRelay

Parameter

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCComGetTime()

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.

Export: DFComDLL als _DFCComGetTime@12
DFCom_x64 als DFCComGetTime

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[out]	dateTimeBuffer	Datenarray für die Werte von Datum und Uhrzeit.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCComSendInfotext()

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.

Export: DFComDLL als _DFCComSendInfotext@16
DFCom_x64 als DFCComSendInfotext

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[in]	text	Zeichenfolge mit dem anzuzeigenden Text.
[in]	textLength	Länge des anzuzeigenden Textes.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCComSendMessage()

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.

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 Fehlermeldung 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] 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.

Wert	Bedeutung
0	Nachricht, wenn möglich anzeigen.
1	Nachricht enthält zusätzliche Steuerdaten.

[in]

audibleSignal

Meldung aktustisch untermalen.

Symbol	Bedeutung
+	50 ms Ton an
-	50 ms Ton aus

Wert	Bedeutung
0	- Off
1	++++++++ Ok
2	+++++--—+++++ Error
3	+++++
4	++–+++++
5	++–++
6	+++++–+++++
7	++–++–++
8	+++++–+++++–+++++
9	++–+++++–++
10	+++++–++–+++++

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCComSetTime()

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.

Export: DFComDLL als _DFCComSetTime@12
DFCom_x64 als DFCComSetTime

Parameter

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCGetDeviceId()

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.

Export: DFComDLL als DFCGetDeviceId
DFCom_x64 als DFCGetDeviceId

Zu beachten: Eine eindeutige Geräte-Id des Datafox-Gerätes erhalten.

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[out]	value	Id.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.03.21 enthalten.

◆ DFCGetDevicePollRetry()

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.

Export: DFComDLL als _DFCGetDevicePollRetry@4
DFCom_x64 als DFCGetDevicePollRetry

Parameter

[in] connectionNumber Zu verwendende Verbindungsnummer.

Rückgabe: Anzahl der benötigten Versuche bis Gerät als verfügbar galt.

◆ DFCGetErrorText()

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.

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]	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.

◆ DFCGetGlobVar()

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.

Export: DFComDLL als _DFCGetGlobVar@28
DFCom_x64 als DFCGetGlobVar

Parameter

[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.

Wert	Bedeutung
0	`name` zeigt auf ein Indexbyte. Der gültige Wertebereich ist 1 - 8.
1	`name` zeigt auf eine Zeichenfolge mit dem Namen einer Setupvariablen. Maximal 16 Zeichen.
2	`name` zeigt auf eine Zeichenfolge mit dem Namen einer Systemvariablen.

[out]

value

Zeichenarray für den Wert.

Wert	Bedeutung
`nameType` = 0 oder 1	Bis Firmware Version 04.03.00 maximal 20 Zeichen, danach maximal 60 Zeichen.
`nameType` = 2	Die mögliche Länge ist abhängig von der Systemvariablen.

[in] valueLength Länge des Zeichenarrays value.

[out] errorNumber Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCGetInfo()

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.)

Export: DFComDLL als _DFCGetInfo@28
DFCom_x64 als DFCGetInfo

Parameter

[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:

Bereich	Bedeutung
ACCESS	für Zutritt
FINGERPRINT	für Fingerprint
USBHOST	für USB-Host

der zweite Teil gibt den Namen der anzusprechenden Komponende an, und kann folgende Zeichenfolgen sein:

Bereich	Komponente	Bedeutung
ACCESS	MODULE	Zutrittsmodul / -leser
FINGERPRINT	MODULE	Fingerprintmodul Firmwareversion
USBHOST	MODULE	USB-Host Firmwareversion (z.B. "3.62-000VDAP")

[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:

Bereich	Parameter	Bedeutung
ACCESS.MODULE	1	Tü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.MODULE	2	Optional die Bus-Id bei Systemen mit mehreren Zutrittsbussen. Bei fehlen, wird der erste Bus angenommen.
FINGERPRINT.MODULE	1	Leer
USBHOST.MODULE	1	Leer

[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.

Wert	Komponente	Bedeutung
Status	1	Gibt den aktuellen Status des Moduls zurück. Genauere Angaben hierzu finden sie im Handbuch im Unterkapitel "Statusmeldungen der Zutrittskontrolle" der Zutrittskontrolle 2.
Name	2	Gibt die Bezeichnung des angesprochenen Moduls zurück.
Firmwareversion	3	Gibt die Firmwareversion des angesprochenen Moduls zurück.

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.01.04 enthalten.

◆ DFCGetLastErrorNumber()

DF_API_EXTERN int DF_API_CALL DFCGetLastErrorNumber	(	int	connectionNumber,
		int	deviceAddress
	)

Liefert die Fehlernummer welche zuletzt aufgetreten ist.

Export: DFComDLL als DFCGetLastErrorNumber
DFCom_x64 als DFCGetLastErrorNumber

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.

Rückgabe: Fehlernummer. Siehe Tabelle der Fehlernummern.

Seit: 04.03.08 enthalten

◆ DFCGetOptionFirmware()

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.

Export: DFComDLL als _DFCGetOptionFirmware@20
DFCom_x64 als DFCGetOptionFirmware

Veraltet:: Bitte beachten Sie, dass die Optionen 1 - 8 eine Firmwareversion kleiner 04.03.00 voraussetzen. Diese Optionen werden nicht durch die Firm- und Softwareversion 04.03.xx beachtet. Die Option "Setup und Listen beibehalten" wird weiterhin unterstützt.

Parameter

[in] connectionNumber Zu verwendende Verbindungsnummer.

[in] deviceAddress Anzusprechende Geräteadresse.

[out]

mask

Wert der angesprochenen Optionen.

Bitnummer	Wert	Bedeutung
1	1	Serie der externen Zutrittsleser. Wertbedeutung der Option 0 = GIS, 1 = PHG
2	2	Verwendung eines Datafox IO-Modul für MDE.
3	4	Verwendung angebundener Timeboys.
4	8	Unterstützung der Com-Server Funktionalität über DLL-Funktionen vorhanden.
5	16	Transpondermenü zum Programmieren der Ausweise am Terminal vorhanden.
6	32	Update des Biokey-Moduls über DLL-Funktion vorhanden.
7	64	Unterstützung des Http - Protokolls vorhanden.
8	128	Unterstüztung der Signalverarbeitung (digitaler Eingänge) vorhanden.
9	256	Vorhandenes Setup und Listen werden übernommen und durch ein Firmwareupdate nicht gelöscht.
...		Nicht verwendet. Bitte immer 0 übergeben.

Die Maske gibt an, welche Werte ausgelesen wurden und somit über den Parameter options zur Verfügung stehen.

[out]

options

Aktueller Zustand der Option.

Wert	Bedeutung
0	Aus
1	Ein

Der Zustand der Maske in Kombination der Bits gibt an, ob die Option aktiviert oder deaktiviert ist.

// 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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.01.04 enthalten

◆ DFCGetRelayState()

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.

Export: DFComDLL als _DFCGetRelayState@24
DFCom_x64 als DFCGetRelayState

Parameter

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCGetSeriennummer()

int DF_API_CALL DFCGetSeriennummer	(	int	connectionNumber,
		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]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	deviceAddress	Anzusprechende Geräteadresse.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.
[out]	value	Seriennummer.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCGetVersionFirmware()

int DF_API_CALL DFCGetVersionFirmware	(	int	connectionNumber,
		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] connectionNumber Zu verwendende Verbindungsnummer.

[in] deviceAddress Anzusprechende Geräteadresse.

[out]

value

Zeichenpuffer für die Firmwareversion. Mindestgröße 64 Byte.

Gerätenummer	Name	Kürzel
255	Unbekannter Gerätetyp
0	PZE-MasterIV	PZE
1	ZK-MasterIV	ZK
2	BDE-MasterIV	BDE
3	Mobil-MasterIV	MOBIL
4	MDE-BoxIV	MDE
5	AE-MasterIV	AE
6	TimeboyIV	TIMEBOY
7	Exklusiv-Line IV	EXKLUSIV
8	Flex-MasterIV	FLEX
9	TimeboyIV Mobil-PZE	TB-MOBIL-PZE
10	EVO 2.8	Evo28
11	EVO 4.3	Evo43
12	IPC Embedded-System	VARIO
13	IPC Embedded-System	IPC
14	IPC Embedded-System	Q7
15	IO-Box V4	IOBOX
16	KYO Inloc	ZKBOX
17	Mobil-Box V4	MOBILBOX
18	Dockingstation V2	DockingV2
19	Fahrzeugdatenlogger V2	LoggerV2
20	KYO Oneloc	ZKKNOTEN
21	EVO 3.5 Universal	EVO_3_5_UNIVERSAL
22	SAMS-OCL-Reader	SAMS-OCL
23	EVO 3.5	EVO35
24	EVO Agera	ZKREADERPLUS
25	KYO Cenloc	25
26	Vario 10	26
27	Vario 12	27
28	Vario 15	28
29	Vario 17	29
30	IPC EVO 12.1	30
31	IPC EVO 15	31
32	IPC EVO 18.5	32
33	IPC EVO 24	33
34	EVO Intera 2	34
35	EVO 4.6 FlexKey	35
36	EVO 5.0 Pure	36
37	KYO Fourloc	37

[out] errorNumber Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCOpenRelay()

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.

Export: DFComDLL als _DFCOpenRelay@16
DFCom_x64 als DFCOpenRelay

Parameter

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCPressVirtualKey()

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.

Export: DFComDLL als _DFCPressVirtualKey@20
DFCom_x64 als DFCPressVirtualKey

Parameter

[in] connectionNumber Zu verwendende Verbindungsnummer.

[in] deviceAddress Anzusprechende Geräteadresse.

[in]

keyCode

Gibt den Tastencode an.

Wert	Bedeutung
112	F1 -> Entspricht einem drücken der Funktionstaste 1.
113	F2 -> Entspricht einem drücken der Funktionstaste 2.
114	F3 -> Entspricht einem drücken der Funktionstaste 3.
115	F4 -> Entspricht einem drücken der Funktionstaste 4.
116	F5 -> Entspricht einem drücken der Funktionstaste 5.
117	F6 -> Entspricht einem drücken der Funktionstaste 6.
118	F7 -> Entspricht einem drücken der Funktionstaste 7.
119	F8 -> Entspricht einem drücken der Funktionstaste 8.
120	F9 -> Entspricht einem drücken der Funktionstaste 9.
121	F10 -> Entspricht einem drücken der Funktionstaste 10.
122	F11 -> Entspricht einem drücken der Funktionstaste 11.
123	F12 -> Entspricht einem drücken der Funktionstaste 12.
124	F13 -> Entspricht einem drücken der Funktionstaste 13.
125	F14 -> Entspricht einem drücken der Funktionstaste 14.
126	F15 -> Entspricht einem drücken der Funktionstaste 15.

[in]

flags

Gibt zusatzliche Bedeutungen zum Tastendruck an:

Bitnummer	Wert	Bedeutung
1	1	Wenn 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] errorNumber Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.01.07 enthalten.

◆ DFCReadDataBlock()

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.

Export: DFComDLL als DFCReadDataBlock
DFCom_x64 als DFCReadDataBlock

Parameter

[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.

Bitnummer	Wert	Bedeutung
1	1	Sitzt dieses Flag wird eine Datei im Tempverzeichnis erstellt, falls die angegebene Puffergröße nicht ausreicht um die ausgelesenen Daten zu fassen. Der Rückgabewert der Funktion ist in diesem Fall 2 und in data wird der Dateiname abgelegt. Sie sind anschließend für das Löschen der Datei verantwortlich.
...	...	Reserviert

Rückgabewerte

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.

Seit: 04.03.12 enthalten.

◆ DFCRecordVolume()

int DF_API_CALL DFCRecordVolume	(	int	connectionNumber,
		int	deviceAddress,
		int *	recordCount,
		int *	memoryUsage,
		int *	memorySize,
		int *	errorNumber
	)

◆ DFCReset()

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.

Export: DFComDLL als _DFCReset@16
DFCom_x64 als DFCReset

Parameter

[in] connectionNumber Zu verwendende Verbindungsnummer.

[in] deviceAddress Anzusprechende Geräteadresse.

[in]

mode

Modus, welche angibt was zurückgesetzt wird.

Wert	Bedeutung
1	Warmstart des Gerätes.
2	Flash formatieren. (Setup und Listen müssen neu aufgespielt werden!)
3	Setup löschen. (Setup und Listen müssen neu aufgespielt werden!)
8	Neustart der Kommunikation zur Übernahme einer geänderten Kommunikationskonfiguration.

[out] errorNumber Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.01.07 enthalten.

◆ DFCSetCallBack()

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.

Export: DFComDLL als _DFCSetCallBack@8
DFCom_x64 als DFCSetCallBack

Parameter

[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.

◆ DFCSetCommunicationPassword()

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.

Export: DFComDLL als _DFCSetCommunicationPassword@20
DFCom_x64 als DFCSetCommunicationPassword

Parameter

[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.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.02.03 enthalten.

◆ DFCSetFontType()

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.

Export: DFComDLL als _DFCSetFontType@16
DFCom_x64 als DFCSetFontType

Parameter

[in] connectionNumber Zu verwendende Verbindungsnummer.

[in] deviceAddress Anzusprechende Geräteadresse.

[in]

type

Typ der zu vewendenden Schriftart.

Wert	Bedeutung
0	Standardschrift
1	16 Pixel (7 Anzeigezeilen)
2	16 Pixel, feste breite (7 Anzeigezeilen)
3	19 Pixel (6 Anzeigezeilen)
4	19 Pixel, feste breite (6 Anzeigezeilen)
5	21 Pixel (5 Anzeigezeilen)
6	21 Pixel, feste breite (5 Anzeigezeilen)

[out] errorNumber Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.01.07 enthalten.

◆ DFCSetGlobVar()

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.

Export: DFComDLL als _DFCSetGlobVar@24
DFCom_x64 als DFCSetGlobVar

Parameter

[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.

Wert	Bedeutung
0	`name` zeigt auf ein Indexbyte. Der gültige Wertebereich ist 1 - 8.
1	`name` zeigt auf eine Zeichenfolge mit dem Namen einer Setupvariablen. Maximal 16 Zeichen.
2	`name` zeigt auf eine Zeichenfolge mit dem Namen einer Systemvariablen.

[in]

value

Zeichenfolge mit dem zu setzenden Wert.

Wert	Bedeutung
`nameType` = 0 oder 1	Bis Firmware Version 04.03.00 maximal 20 Zeichen, danach maximal 60 Zeichen.
`nameType` = 2	Die mögliche Länge ist abhängig von der Systemvariablen.

[out] errorNumber Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

◆ DFCSetOptionFirmware()

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.

Export: DFComDLL als _DFCSetOptionFirmware@20
DFCom_x64 als DFCSetOptionFirmware

Veraltet:: Bitte beachten Sie, dass die Optionen 1 - 8 eine Firmwareversion kleiner 04.03.00 voraussetzen. Diese Optionen werden nicht durch die Firm- und Softwareversion 04.03.xx beachtet. Die Option "Setup und Listen beibehalten" wird weiterhin unterstützt.

Zu beachten: Die Option "Setup und Listen beibehalten" wird in der Version 04.03.xx voll unterstützt. Sie wird auserdem noch ab der Mobil-MasterIV-Version 04.01.04.32 unterstützt, hierbei muss beim Update mindestens die Firmwareversion 04.01.04.59 übertragen werden.

Parameter

[in] connectionNumber Zu verwendende Verbindungsnummer.

[in] deviceAddress Anzusprechende Geräteadresse.

[in]

mask

Maske of the options to be accessed.

Bitnummer	Wert	Bedeutung
1	1	Serie der externen Zutrittsleser. Wertbedeutung der Option 0 = GIS, 1 = PHG
2	2	Verwendung eines Datafox IO-Modul für MDE.
3	4	Verwendung angebundener Timeboys.
4	8	Unterstützung der Com-Server Funktionalität über DLL-Funktionen vorhanden.
5	16	Transpondermenü zum Programmieren der Ausweise am Terminal vorhanden.
6	32	Update des Biokey-Moduls über DLL-Funktion vorhanden.
7	64	Unterstützung des Http - Protokolls vorhanden.
8	128	Unterstüztung der Signalverarbeitung (digitaler Eingänge) vorhanden.
9	256	Vorhandenes Setup und Listen werden übernommen und durch ein Firmwareupdate nicht gelöscht.
...		Nicht verwendet. Bitte immer 0 übergeben.

Sie geben durch die gesetzten Bits an, welche Optionen bei der Ausführung beachtet werden.
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.

Wert	Bedeutung
0	Aus
1	Ein

Der Zustand der Bits gibt an ob die Option aktiviert oder deaktiviert werden soll. Als Beispiel geben Sie für die obige Beispielmaske, für das Deaktivieren der Optionen "Transpondermenü" und Aktivieren der Option "Setup und Listen beibehalten" (0 + 256 =) 256 als Wert an. Alle anderen Bits, werden durch die angegebene Maske ignoriert.

[out] errorNumber Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.01.04 enthalten

◆ DFCSetPassword()

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.

Export: DFComDLL als _DFCSetPassword@12
DFCom_x64 als DFCSetPassword

Parameter

[in]	connectionNumber	Zu verwendende Verbindungsnummer.
[in]	value	Zeichenfolge des Passworts. Maximal 16 Zeichen.
[out]	errorNumber	Fehlernummer bei fehlerhafter Ausführung.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausfü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]	value	Zeiger auf Zeichenfolgenpuffer für die Version.
[in]	valueLength	Länge des reservierten Puffers für die Zeichenfolge. Muss mindestens 12 sein.

Rückgabewerte

0	Fehler bei Ausführung.
1	Ausführung war erfolgreich.

Seit: 04.03.00 enthalten