Datafox DFCom - API 04.03.22
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
df_access_control.h-Dateireferenz
#include "df_defines.h"

gehe zum Quellcode dieser Datei

Funktionen

int DF_API_CALL DFCEntrance2Identification (int connectionNumber, int deviceAddress, const char *readerTM, const char *identificationId, const char *identificationPin, char *statusText, int *statusTextLength, int *errorNumber)
 Löst eine virtuelle Zutrittsbuchung in der Zutrittskontrolle des Gerätes aus.
 
int DF_API_CALL DFCEntrance2OnlineAction (int connectionNumber, int deviceAddress, const char *readerTM, int mask, int type, int duration, int *errorNumber)
 Löst im Online-Modus der Zutrittskontrolle des Gerätes, eine Leser-Aktion durch.
 
int DF_API_CALL DFCAccessControlIdentification (int connectionNumber, int deviceAddress, int masterId, const char *readerTM, const char *identificationId, const char *identificationPin, char *statusText, int *statusTextLength, int *errorNumber)
 Löst eine virtuelle Zutrittsbuchung in der Zutrittskontrolle des Gerätes aus.
 
int DF_API_CALL DFCAccessControlOnlineAction (int connectionNumber, int deviceAddress, int masterId, const char *readerTM, int mask, int type, int duration, int *errorNumber)
 Löst im Online-Modus der Zutrittskontrolle des Gerätes, eine Leser-Aktion aus.
 

Dokumentation der Funktionen

◆ DFCAccessControlIdentification()

int DF_API_CALL DFCAccessControlIdentification ( int  connectionNumber,
int  deviceAddress,
int  masterId,
const char *  readerTM,
const char *  identificationId,
const char *  identificationPin,
char *  statusText,
int *  statusTextLength,
int *  errorNumber 
)

Löst eine virtuelle Zutrittsbuchung in der Zutrittskontrolle des Gerätes aus.

Die Funktion lässt sich aus Sicherheitsgründen nur auf Ausweise anwenden die im Feld "ActiveGeneral" der Liste "Identification" entweder den Wert "2" oder "9" eingetragen haben.

Export
DFComDLL als _DFCAccessControlIdentification@36
DFCom_x64 als DFCAccessControlIdentification
Zu beachten
Nähere Informationen für die zu übergebenden Feldwerte (TM, Id, Pin) sowie den zurückgelieferten Status (statusText) entnehmen Sie bitte dem jeweilingen Handbuch aus dem Kapitel "Zutrittskontrolle" und Unterkapitel "Statusmeldungen".
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]masterIdAnzusprechende Master-Id. Diese entspricht dem Zutrittsbus bei Geräten mit mehreren Zutrittsstängen. Standardwert ist 1. Wertebereich 1 - 9999.
[in]readerTMFeldwert entsprechend des Feldes "TM" der Liste "Reader". Er muss demnach immer 3 Ziffern umfassen.
[in]identificationIdFeldwert entsprechend des Feldes "Id" der Liste "Identification". Er darf maximal 20 Zeichen lang sein.
[in]identificationPinFeldwert entsprechend des Feldes "Pin" der Liste "Identification". Er darf maximal 8 Ziffern beinhalten.
[in]statusTextZeichenarray für den Status der Zutrittsprüfung. Sie sollten mindestens 5 Zeichen vorsehen.
[in,out]statusTextLengthAls in die Länge des Arrays für statusText, 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.03.04 enthalten

◆ DFCAccessControlOnlineAction()

int DF_API_CALL DFCAccessControlOnlineAction ( int  connectionNumber,
int  deviceAddress,
int  masterId,
const char *  readerTM,
int  mask,
int  type,
int  duration,
int *  errorNumber 
)

Löst im Online-Modus der Zutrittskontrolle des Gerätes, eine Leser-Aktion aus.

Steuern des Buzzer, LED und Relais eines Zutrittslesers im Online-Modus der Zutrittskontrolle.

Export
DFComDLL als _DFCAccessControlOnlineAction@32
DFCom_x64 als DFCAccessControlOnlineAction
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]masterIdAnzusprechende Master-Id. Diese entspricht dem Zutrittsbus bei Geräten mit mehreren Zutrittsstängen. Standardwert ist 1. Wertebereich 1 - 9999.
[in]readerTMFeldwert entsprechend des Feldes "TM" der Liste "Reader". Er muss demnach immer 3 Ziffern umfassen.
[in]maskWert der anzusprechenden Komponenten. Als Ausgang kann je nach verwendetem Modul, ein Relais oder ein digitaler Ausgang vorliegen.
BitnummerWertBedeutung
11Buzzer
22Grüne LED
34Rote LED
48Ausgang 1
516Ausgang 2
632Ausgang 3
764Ausgang 4
8128Gelbe LED
9256Ausgang 5
10512Ausgang 6
111024Ausgang 7
122048Ausgang 8
134096Ausgang 9
148192Ausgang 10
1516384Ausgang 11
1632768Ausgang 12
BitnummerWertBedeutung
1765536Ausgang 13
18131072Ausgang 14
19262144Ausgang 15
20524288Ausgang 16
211048576Ausgang 17
222097152Ausgang 18
234194304Ausgang 19
248388608Ausgang 20
2516777216Ausgang 21
2633554432Ausgang 22
2767108864Ausgang 23
28134217728Ausgang 24
29268435456Ausgang 25
30536870912Ausgang 26
311073741824Ausgang 27
322147483648Ausgang 28
Sie geben durch die gesetzten Bits an, welche Komponenten bei Ausführung angesprochen werden sollen.
Als Beispiel geben Sie für das ansprechen der Grünen LED und des 9 Relais (2 + 4096 =) 4098 als Wert an.
[in]typeAnzunehmenden Zustand der gewählten Komponenten.
WertBedeutung
0Aus
1Ein
2Dauerhaft im Wechsel 600ms an, 600ms aus.
3Drei mal im Wechsel 400ms an, 400ms aus
[in]durationZusätzliche Zeitangabe bei Angabe von type = 1. Ansonsten wird der Wert ignoriert.
WertBedeutung
0Dauerhaft
1 bis 40Anzahl Sekunden für den Zustand: Ein
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.03.04 enthalten

◆ DFCEntrance2Identification()

int DF_API_CALL DFCEntrance2Identification ( int  connectionNumber,
int  deviceAddress,
const char *  readerTM,
const char *  identificationId,
const char *  identificationPin,
char *  statusText,
int *  statusTextLength,
int *  errorNumber 
)

Löst eine virtuelle Zutrittsbuchung in der Zutrittskontrolle des Gerätes aus.

Die Funktion lässt sich aus Sicherheitsgründen nur auf Ausweise anwenden die im Feld "ActiveGeneral" der Liste "Identification" entweder den Wert "2" oder "9" eingetragen haben.

Export
DFComDLL als _DFCEntrance2Identification@32
DFCom_x64 als DFCEntrance2Identification
Veraltet:
Bitte verwenden Sie wenn möglich DFCAccessControlIdentification(). Diese biedet Ihnen zusätzlich die Angabe eines speziellen Zutrittsbusses, wenn mehrere Zutrittsstränge verfügbar sein sollten.
Zu beachten
Nähere Informationen für die zu übergebenden Feldwerte (TM, Id, Pin) sowie den zurückgelieferten Status (statusText) entnehmen Sie bitte dem jeweilingen Handbuch aus dem Kapitel "Zutrittskontrolle" und Unterkapitel "Statusmeldungen".
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]readerTMFeldwert entsprechend des Feldes "TM" der Liste "Reader". Er muss demnach immer 3 Ziffern umfassen.
[in]identificationIdFeldwert entsprechend des Feldes "Id" der Liste "Identification". Er darf maximal 20 Zeichen lang sein.
[in]identificationPinFeldwert entsprechend des Feldes "Pin" der Liste "Identification". Er darf maximal 8 Ziffern beinhalten.
[in]statusTextZeichenarray für den Status der Zutrittsprüfung. Sie sollten mindestens 5 Zeichen vorsehen.
[in,out]statusTextLengthAls in die Länge des Arrays von statusText, 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

◆ DFCEntrance2OnlineAction()

int DF_API_CALL DFCEntrance2OnlineAction ( int  connectionNumber,
int  deviceAddress,
const char *  readerTM,
int  mask,
int  type,
int  duration,
int *  errorNumber 
)

Löst im Online-Modus der Zutrittskontrolle des Gerätes, eine Leser-Aktion durch.

Steuern des Buzzer, LED und Relais eines Zutrittslesers im Online-Modus der Zutrittskontrolle.

Export
DFComDLL als _DFCEntrance2OnlineAction@28
DFCom_x64 als DFCEntrance2OnlineAction
Veraltet:
Bitte verwenden Sie wenn möglich DFCAccessControlOnlineAction(). Diese biedet Ihnen zusätzlich die Angabe eines speziellen Zutrittsbusses, wenn mehrere Zutrittsstränge verfügbar sein sollten.
Parameter
[in]connectionNumberZu verwendende Verbindungsnummer.
[in]deviceAddressAnzusprechende Geräteadresse.
[in]readerTMFeldwert entsprechend des Feldes "TM" der Liste "Reader". Er muss demnach immer 3 Ziffern umfassen.
[in]maskWert der anzusprechenden Komponenten. Als Ausgang kann je nach verwendetem Modul, ein Relais oder ein digitaler Ausgang vorliegen.
BitnummerWertBedeutung
11Buzzer
22Grüne LED
34Rote LED
48Ausgang 1
516Ausgang 2
632Ausgang 3
764Ausgang 4
8128Gelbe LED
9256Ausgang 5
10512Ausgang 6
111024Ausgang 7
122048Ausgang 8
134096Ausgang 9
148192Ausgang 10
1516384Ausgang 11
1632768Ausgang 12
BitnummerWertBedeutung
1765536Ausgang 13
18131072Ausgang 14
19262144Ausgang 15
20524288Ausgang 16
211048576Ausgang 17
222097152Ausgang 18
234194304Ausgang 19
248388608Ausgang 20
2516777216Ausgang 21
2633554432Ausgang 22
2767108864Ausgang 23
28134217728Ausgang 24
29268435456Ausgang 25
30536870912Ausgang 26
311073741824Ausgang 27
322147483648Ausgang 28
Sie geben durch die gesetzten Bits an, welche Komponenten bei Ausführung angesprochen werden sollen.
Als Beispiel geben Sie für das ansprechen der Grünen LED und des 9 Relais (2 + 4096 =) 4098 als Wert an.
[in]typeAnzunehmenden Zustand der gewählten Komponenten.
WertBedeutung
0Aus
1Ein
2Dauerhaft im Wechsel 600ms an, 600ms aus.
3Drei mal im Wechsel 400ms an, 400ms aus
[in]durationZusätzliche Zeitangabe bei Angabe von type = 1. Ansonsten wird der Wert ignoriert.
WertBedeutung
0Dauerhaft
1 bis 40Anzahl Sekunden für den Zustand: Ein
[out]errorNumberFehlernummer bei fehlerhafter Ausführung.
Rückgabewerte
0Fehler bei Ausführung.
1Ausführung war erfolgreich.
Seit
04.01.05 enthalten

© 2003-2024 Datafox GmbH