Dokumentation zur DFComDLL.dll 
(Vers. 04.01.07)

Inhalt:

1   Einleitung
1. 1   Was sind Kanalnummer und Busnummer ?
1. 1. 1   Was ist die Kanalnummer (channelID)?
1. 1. 2   Was ist die Busnummer (deviceID)?
1. 2   Exemplarischer Programmaufbau.
1. 3   Versionsänderungen
1. 4   Funktionsweise der DLL
1. 5   Allgemeine Hinweise
1. 5. 1   Listen des Setups
1. 5. 2   Datentypen
1. 5. 3   Fehler
1. 5. 4   Hintergrundloggen
1. 5. 5   Uhrzeit stellen
1. 5. 6   Übertragen von Timeboylisten
1. 5. 7   Übertragen von Gerätedateien (DFCUpload)
1. 5. 8   IP-Adresse und Hostname
1. 6   Aktive Verbindung
1. 6. 1   Einleitung
1. 6. 2   Grober Überblick
1. 6. 3   Kurze Gegenüberstellung der Befehlsausführung ohne und mit "Aktiver Verbindung"
1. 6. 4   Starten Stoppen und Initialisieren der "Aktiven Verbindung"
1. 6. 5   Melden von Datensätzen
1. 6. 6   Inbetriebnehmen und Testen
2   Exportierte Funktionen
2. 1   Allgemeine Funktionen
2. 1. 1. 1 DFCComInit Serielle Schnittstelle für AEIII+ initialisieren.
2. 1. 1. 2 DFCComOpenSerial Serielle Schnittstelle für AEIII+ initialisieren.
2. 1. 1. 3 DFCComOpen TCP/IP - Schnittstelle für AEIII+ initialisieren.
2. 1. 1. 4 DFCComOpenSocket TCP/IP - Schnittstelle für AEIII+ initialisieren.
2. 1. 2   DFCComOpenIV Serielle oder TCP/IP für MasterIV initialisieren.
2. 1. 3   DFCComClose Zuvor geöffnete Schnittstelle schließen.
2. 1. 4. 1 DFCCheckAE Erreichbarkeit prüfen.
2. 1. 4. 2 DFCCheckDevice Erreichbarkeit prüfen.
2. 1. 5   DFCComSetTime Datum und Uhrzeit schreiben.
2. 1. 6   DFCComGetTime Datum und Uhrzeit lesen.
2. 1. 7   DFCComSendMessage Anzeigemeldung senden.
2. 1. 8   DFCComSendInfotext Hintergrundmeldung senden.
2. 1. 9   DFCGetSeriennummer Seriennummer lesen.
2. 1. 10. 1 DFCLogOn Nicht weiter verwenden.
2. 1. 10. 2 DFCSetLogOn Protokollierung einschalten.
2. 1. 11. 1 DFCLogOff Nicht weiter verwenden.
2. 1. 11. 2 DFCSetLogOff Protokollierung ausschalten.
2. 1. 12   DFCSetCallBack Rückruffunktion bekannt geben.
2. 1. 13   DFCSetLogFileName Name der Protokollierungsdatei setzen.
2. 1. 14   DFCGetErrorText Fehlernummer zu Fehlertext umsetzen.
2. 1. 15   DFCSetGlobVar Wert einer Variablen ändern.
2. 1. 16   DFCGetGlobVar Wert einer Variablen ermitteln.
2. 1. 17   DFCCloseRelay Relais für bestimmbare Zeit schließen.
2. 1. 18   DFCGetRelayState Relaiszustand abfragen.
2. 1. 19   DFCOpenRelay Relais öffnen.
2. 1. 20   DFCGetDevicePollRetry Anzahl Ermittlungsversuche ermitteln.
2. 1. 21   DFCGetComPort Rückgabe des Schnittstellenhandle.
2. 1. 22   DFCSetComPort Setzen des Schnittstellenhandle.
2. 1. 23   DFCWrite In den Kanal schreiben.
2. 1. 24   DFCRead Aus dem Kanal lesen.
2. 1. 25   DFCUpload Gerätedaten (Firmware) laden.
2. 1. 26   DFCGetVersionFirmware Version der Gerätesoftware lesen.
2. 1. 27   DFCGetVersionFirmwareFromFile Version der Gerätesoftware lesen.
2. 1. 28   DFCGetInfo Informationen zu einem Modul abfragen.
2. 1. 29   DFCOpenComServerMode Transparentmodus einschalten.
2. 1. 30   DFCCloseComServerMode Transparentmodus ausschalten.
2. 1. 31   DFCIsChannelOpen Besteht eine Kommunikationsverbindung.
2. 1. 32   DFCUploadModule Update eines eingebauten Moduls durchführen.
2. 1. 33   DFCGetOptionFirmware Zusatzoptionen der Firmware lesen.
2. 1. 34   DFCSetOptionFirmware Zusatzoptionen der Firmware schreiben.
2. 1. 35   DFCReset Rücksetzfunktion je nach Aufrufmodus.
2. 1. 36   DFCSetFontType Zeichensatztyp für SendMessage und SendInfotext.
2. 1. 37   DFCSetPassword Setzen des Passworts für die Kommunikation.
2. 1. 38   DFCGetPasswordKey Abfragen eines Ersatzschlüssels für Passwort.
2. 1. 39   DFCPressVirtualKey Virtuelles betätigen von Funtkionstasten (F1 - F15)
2. 1. 40   DFCGetFlashStatus Aktuellen Zustand des Speicherbausteins abrufen.
2. 2   Funktionen für Setup
2. 2. 1   DFCSetupLaden Setupdatei zum Gerät übertragen.
2. 2. 2   DFCDownload Setupdaten aus Gerät in Datei schreiben.
2. 2. 3   DFCModifyStudioFile Setupdaten in Setupdatei verändern.
2. 3   Funktionen für Listen, sowie Zutrittslisten (Version 2)
2. 3. 1   DFCOpenTable Öffnen einer Tabelle.
2. 3. 2   DFCCloseTable Schließen einer Tabelle.
2. 3. 3   DFCSetFilter Filterkriterium setzen.
2. 3. 4   DFCGetFilter Aktuelles Filterkriterium lesen.
2. 3. 5   DFCClearFilter Filterkriterium entfernen.
2. 3. 6   DFCSkip Datensatzzeiger verschieben.
2. 3. 7   DFCSetField Wert eines Datensatzfeldes ändern.
2. 3. 8   DFCGetField Wert eines Datensatzfeldes ermitteln.
2. 4   Funktionen für Daten
2. 4. 1   DFCComClearData Datenzeiger im Gerät zurücksetzen.
2. 4. 2   DFCComCollectData Datenabholvorgang starten.
2. 4. 3   DFCComGetDatensatz Datensatz ermitteln.
2. 4. 4   DFCLoadDatensatzbeschreibung Datensatzbeschreibungen aus Gerätesetup ermitteln.
2. 4. 5   DFCDatBCnt Anzahl ermittelter Datensatzbeschreibungen.
2. 4. 6   DFCDatBDatensatz Grunddaten einer ermittelten Datensatzbeschreibung erhalten.
2. 4. 7   DFCDatBFeld Grunddaten eines ermittelten Datensatzbeschreibungsfeldes erhalten.
2. 4. 8   DFCReadRecord Nächsten anstehenden Datensatz lesen.
2. 4. 9   DFCQuitRecord Zuvor gelesenen Datensatz quittieren (löschen).
2. 4. 10   DFCRestoreRecords Wiederherstellen von Datensätzen.
2. 5   Funktionen für Listen
2. 5. 1   DFCMakeListe Rohdaten einer Liste importieren.
2. 5. 2   DFCLoadListen Importierte Listendaten in Gerät schreiben.
2. 5. 3   DFCClrListenBuffer Listenspeicher für Import löschen.
2. 5. 4   DFCLoadListenbeschreibung Listenbeschreibungen aus Gerätesetup ermitteln.
2. 5. 5   DFCListBCnt Anzahl ermittelter Listenbeschreibungen.
2. 5. 6   DFCListBDatensatz Grunddaten einer ermittelten Listenbeschreibung erhalten.
2. 5. 7   DFCListBFeld Grunddaten eines ermittelten Listenbeschreibungsfeldes erhalten.
2. 6   Funktionen für Zutrittskontrolllisten (Version 1)
2. 6. 1   DFCMakeEntranceList Rohdaten einer Liste importieren.
2. 6. 2   DFCLoadEntranceList Importierte Listendaten in Gerät schreiben.
2. 6. 3   DFCClearEntranceListBuffer Listenspeicher für Import löschen.
2. 7   Funktionen für Zutrittskontrolllisten (Version 2)
2. 7. 1   DFCMakeEntrance2List Rohdaten einer Liste importieren.
2. 7. 2   DFCLoadEntrance2List Importierte Listendaten in Gerät schreiben.
2. 7. 3   DFCClearEntrance2ListBuffer Listenspeicher für Import löschen.
2. 7. 4   DFCEntrance2Identification Zutrittsprüfung per DLL ausführen.
2. 7. 5   DFCEntrance2OnlineAction Zutrittsmodul per DLL ansprechen.
2. 8   Funktionen für Fingerprint
2. 8. 1   DFCFingerprintAppendRecord Anfügen eines Fingertemplates.
2. 8. 2   DFCFingerprintGetRecord Ermitteln der Daten eines Fingertemplates.
2. 8. 3   DFCFingerprintDeleteRecord Löschen von Fingertemplates.
2. 8. 4   DFCFingerprintList Liste mit allen enthaltenen PID-FIDs erstellen.
2. 8. 5   DFCFingerprintBackup Backup aller enthaltener Fingertemplates erstellen.
2. 8. 6   DFCFingerprintRestore Ein vorhandenes Backup von Fingertemplates wiederherstellen.
2. 9   Funktionen für Timeboylisten
2. 9. 1   DFCMakeTimeboyList Rohdaten einer Liste importieren.
2. 9. 2   DFCLoadTimeboyList Importierte Listendaten in Gerät schreiben.
2. 9. 3   DFCClearTimeboyListBuffer Listenspeicher für Import löschen.
2. 10   Funktionen für Aktive Verbindung
2. 10. 1   DFCStartActiveConnection Starten des DLL-Moduls zur Aktiven Verbindungsannahme.
2. 10. 2   DFCStopActiveConnection Stoppen des DLL-Moduls zur Aktiven Verbindungsannahme.
2. 10. 3   DFCGetFirstActiveChannelID Nummer des ersten "Aktiv" verbundenen Kanals ermitteln.
2. 10. 4   DFCGetNextActiveChannelID Nummer des nächsten "Aktiv" verbundenen Kanals ermitteln.
2. 10. 5   DFCGetInfoActiveChannel Informationen zum "Aktiv" verbundenen Kanals abrufen.
2. 10. 6   DFCSetRecordAvailable An/Abschaltung der Annahme von der Meldung "Datensatz verfügbar".
2. 10. 7   DFCRecordAvailable Zugriff auf die Warteschlange der Meldung "Datensatz verfügbar".
2. 10. 8   DFCBindDeviceToChannel Ein Gerät an diese Kanalnummer binden.
3   Datenstruktur
3. 1   Aufbau der Datensätze im Bytearray
3. 2   Datum und Uhrzeit im Bytearray
4   Systemvariablen
4. 1   Variablen für Mobilfunk, Präfix: _MODEM_MC35i / MOBILE
4. 2   Variablen für Bedienung, Präfix: SERVICE
4. 3   Variablen für Zutritt, Präfix: ACCESS
4. 4   Variablen für Bluetooth, Präfix: BTH
4. 5   Variablen für digitale Ein-/Ausgänge, Präfix: IO
4. 6   Variablen zum Präfix: POWER
4. 7   Variablen für Aktive Verbindung, Präfix: COM

1     Einleitung

Die DLL "DFComDLL.dll" stellt die grundlegenden Funktionen für die Kommunikation über RS232 bzw. RS485 sowie TCP / IP zur Verfügung. Sie wird ab Version 2.0.0 vom DatafoxStudioIV / AESetup zu 100% verwendet. Die vorhandenen AEIII+ Techniken wurden auf die MasterIV Hardware übertragen, welche durch eine spezielle Initialisierungsroutine angesprochen werden kann.

1.1     Was sind Kanalnummer und Busnummer ?

  Multithreading ist auf einem Kanalobjekt nicht erlaubt. Pro Kanal nur ein Thread !!

 
Abbildung 1

Die Abb. 1 zeigt einen möglichen Hardwareaufbau mit Datafox - Geräten. Dieses Beispiel soll der Verdeutlichung der Begriffe Kanal und Busnummer dienen.  Die Kanalnummer (ChannelID) ist vergleichbar mit einem Straßennamen. Die Busnummer (DeviceID) ist vergleichbar mit der Hausnummer eines Gebäudes (wird im RS485-Netzwerk verwendet). Im abgebildeten Beispiel gibt es insgesamt drei Kanäle (ChannelID's).

Ein Gerät der Abb.1 kann über folgende Wertangaben (Adresse) eindeutig identifiziert werden:
Für das Gerät A lautet die Adresse:  Kanal: 1, Busnummer: 1
Für das Gerät C lautet die Adresse:  Kanal: 1, Busnummer: 3
Für das Gerät D lautet die Adresse:  Kanal: 2, Busnummer: 1
Für das Gerät F lautet die Adresse:  Kanal: 3, Busnummer: 254, IP: 192.168.123.2, Port: 8000 **
**(Sonderfall: Busnummer immer 254)

Um Informationen an die Geräte zu schicken ist es notwendig, dass der jeweilige Kanal (ChannelID) zuvor geöffnet wurde. In Analogie zum Strassenbeispiel würde dies geöffneten Bahnschranken entsprechen.

Es ist nicht notwendig jedes Mal den verwendeten Kanal (ChannelID) zu schließen, wenn die Kommunikation mit einem Gerät beendet wurde (eine Bahnschranke wird ebenfalls nicht nach jedem durchgefahrenen Auto geschlossen). Die Kommunikationskanäle können beim Start des Programms geöffnet werden (siehe 1.2 Exemplarischer Programmaufbau). Ein Schließen der Kommunikationskanäle (ChannelIDs) ist normalerweise erst bei Programmbeendigung notwendig oder wenn es gewisse Situationen erfordern. 
Notwendig ist das Schließen eines Kanals nach der Kommunikationsunterbrechung bei TCP/IP -Verbindungen, Modemverbindungen.

1.1.1     Was ist die Kanalnummer (channelID)?

Die Kanalnummer (ChannelID) ist vergleichbar mit einem Strassennamen. Jedes Gerät gehört genau zu einem Kommunikationskanal. Die Anzahl der möglichen Kanäle ist auf maximal 250 festgelegt (erlaubter Wertebereich: 1-250). Pro Kanal ist eine Geräteanzahl (siehe Busnummer) von 1..n Einzelgeräten (Endgeräten) möglich. Die maximale Anzahl n(max. sind 31 Geräte pro Kanal möglich) wird von dem gewählten Verbindungsschema (siehe Abb.1) bestimmt.

 Tabelle 1
 Verbindungsschema  Verbindungsart  von - auf  max.
 Anzahl
 Geräte
 pro
 Kanal		  zu verwendende
 Busnummern
 bei
 Funktionsaufrufen
  RS232 RS232  direkt   RS232-RS232  n = 1  immer mit 254 !!
  RS232 RS485  über Umsetzer       RS232-RS485  n = 31  von 1 bis 31
  TCP/IP TCP/IP  direkt  TCP/IP-TCP/IP  n = 1  immer mit 254 !!
  TCP/IP RS485  über COM-Server  TCP/IP-RS485  n = 31  von 1 bis 31
  TCP/IP RS232  über COM-Server  TCP/IP-RS232  n = 1  immer mit 254 !!

1.1.2     Was ist die Busnummer (deviceID)?

Die Busnummer (DeviceID) ist vergleichbar mit der Hausnummer eines Gebäudes. Diese Nummer wird zur Adressierung eines bestimmten Gerätes benötigt. In RS485 Netzwerken (Bussystemen) benötigt jedes Endgerät eine eindeutige Nummer. Diese Nummer (Busnummer) wird an jedem Gerät in dessen BIOS eingestellt. Die maximale Anzahl ist auf 31 Geräte begrenzt (erlaubte Busnummern: 1-31 und 254*).

  Die Busnummer 254 hat eine besondere Bedeutung. Sie darf nicht in RS485 Netzwerken verwendet werden. Über diese Busnummer ist jedes Gerät im RS232 Modus ansprechbar. Wenn kein RS485 Bus angesprochen wird ist bei Funktionsaufrufen (wenn nötig) für die Busnummer (DeviceID) immer 254 anzugeben.

 Die Einstellung der Busnummer ist ab der Firmware Version 04.00.21 des PZE-MastersIV nur noch möglich:
 
  • wenn das Gerät mit der RS485 Option ausgestattet ist
  • wenn im BIOS unter communication / interface die RS485 Kommunikation für das Gerät gewählt wurde.

Wird nicht die Kommunikationsart RS485 (ab der Firmware Version 04.00.21 des PZE-MasterIV) gewählt, ist die Busnummer des Gerätes automatisch 254.

1.2  Exemplarischer Programmaufbau


Abbildung 2

Das nebenstehende Schema (Abb.2) zeigt eine mögliche Grundstruktur für ein Programm, für den in Abb.1 gezeigten Hardwareaufbau. Prinzipiell sollte ein Programmierprojekt wie im nebenstehenden Schema aufgebaut sein. 
Nach dem Start des Programms werden alle benötigten Kanäle (ChannelIDs) initialisiert. Im Normalfall ist es völlig ausreichend wenn bei Beendigung des Programms die geöffneten Kanäle (ChannelIDs) geschlossen werden. Nach der Initialisierung der Kanäle können die Endgeräte beliebig oft angesprochen werden.
Eine erneute Initialisierung wäre nur im Falle einer Kommunikations- unterbrechung notwendig. Hierzu ist der betroffene Kanal erst einmal explizit mit der Funktion DFComClose zu schließen. Erst nach dem Schließen des Kanals ist es zulässig mit einer Initialisierungsfunktion diesen wieder zu öffnen.

 

Mit der Funktion DFCGetComPort hat man zum Beispiel die Möglichkeit zu überprüfen ob eine bestimmte Kanalnummer (ChannelID) bereits geöffnet wurde (bzw. noch geöffnet ist). 

Cpp Beispiel: Überprüfen ob der Kanal 2 geöffnet ist

if (DFCGetComPort( 2 ) != -1) {

printf("Kanal 2 bereits geöffnet.\n");
} else {

printf("Kanal 2 nicht geöffnet.\n");
}

 

1.3     Versionsänderungen

Datum Version Änderungen
08.12.01 1.1.0 Funktionen für Listen aufgenommen.
26.01.02 1.1.c Fehler beim lesen von großen Datenmengen beseitigt.
12.02.02 1.1.e Fehler beseitigt wenn im Gerät kein Datensatz. Neu: Datum/Uhrzeit lesen.
29.04.02 1.1.f Funktion DFCComSendInfotext aufgenommen.
14.06.02 1.1.g Erzeugung der Log-Datei abgeschaltet.
04.07.02 1.1.h Log-Datei kann mit den Funktionen DFCLogOn, DFCLogOff ein- / ausgeschaltet werden.
09.09.02 1.1.i Datensatzbeschreibung und Listenbeschreibung aus dem Gerät auslesen.
09.10.02 1.1.j Prüfen ob Gerät erreichbar. Lesen der Seriennummer und übertragen einer Setupdatei.
 Version 2
21.02.03 02.00.00 Kontrollierter Abschluss der ersten Technik. Einleitung einer neuen Technik, mit Datensatzweisen lesen, Setupdaten aus Gerät lesen und Rückruffunktion.
24.02.03 02.00.01 Entfernen des Fehlers bei Setup laden unter Win9X und WinMe.
01.03.03 02.00.02 Unterstützung von Firmwareständen unter FW 2.0. Auch alte Datensatztechnik.
27.03.03 02.00.03 Abgleichen der Exportschnittstelle zu Talk. Unterstützung von FW >= 3.0
13.05.03 02.00.04 Setzen und lesen der Globalen Variablen durch DFCSetGlobVar und DFCGetGlobVar hinzugefügt.
20.05.03 02.00.05 Schließen, Zustandsabfrage und öffnen des internen und der IOModule - Relais. Importieren und laden der Listendaten für Zutrittskontrolle.
11.06.03 02.00.06 Unterstützung von AESetup unter 02.00.00
15.07.03 02.00.07 Kommunikation mit alter Firmware (V1.14) gefestigt.
07.08.03 02.00.08 DFCComSetTime überarbeitet. Parameter von Gerät bleiben nach manueller Änderung und Setupeinspielung erhalten.
11.08.03 02.00.09 Geräteparameter "Tastenton" hinzugefügt, wobei die anderen vom Setupprogramm nicht einstellbaren Parameter ab Firmwareversion 3.1.2 behalten werden.
05.09.03 02.00.10 Die Funktion DFCComOpenIV zum Ansprechen von MasterIV - Geräten hinzugefügt.
12.09.03 02.00.11 Fehlermapping für PZE-MasterIV überarbeitet. Überarbeitung der Funktion DFCSetupLaden um die globalen Variablen durch die Setup - Daten mit standardwerten zu belegen. (ab Setup V03.01.07)
16.09.03 02.00.12 Bugfix von DFCSetupLaden und Einbau von TCP/IP in DFCComOpenIV.
17.09.03 02.00.13 Änderung um Firmwaredateien für PZE-MasterIV über TCP/IP einzuspielen.
29.09.03 02.00.14 DLL - Projekt auf Linux (SuSE 7.3) portiert. 
24.10.03 02.00.15 Hindergrundloggen aller Funktionsaufrufe eingeführt.
08.12.03 02.00.16 DFCSetGlobVar und DFCGetGlobVar für AESetup überarbeitet.
29.01.04 02.00.17 Überarbeitung der DFCMakeEntranceList und DFCLoadEntranceList - Funktionen, da die Personalnummer im Personalstamm von 12 auf 13 Stellen erhöht wurde.
24.02.04 02.00.17 Erweiterung der Dokumentation um die Funktionen DFCGetComPort und DFCSetComPort.
29.04.04 02.00.18 DFCWrite, DFCRead, DFCUpload hinzugefügt und bei der Kommunikation mit den PZE-MasterIV - Geräten die Größe der Datenpakete erhöht.
DFCGetVersionFirmware hinzugefügt, wird unterstützt ab Firmware 04.00.19
20.07.04 02.00.19 Fehler bei interner Sortierung des Zutrittspersonalstammes bereinigt.
Die Kanalklassenanzahl ist von 10 auf 250 erhöht worden.
Die Listendaten werden bei PZE-MasterIV ab FW 04.00.21 im Hintergrund geladen.
08.10.04 02.00.20 Fehlerbereinigung; bei unaufgeführten internen Kommunikationsversionsnummern, wurde immer der Fehler (Gerät antwortet nicht) geliefert, obwohl der Befehl eigentlich nicht vom Gerät unterstützt wurde. 
Abfrage der Firmwareversion mit DFCGetFirmwareVersion nun auch beim AEIII+ möglich. 
DFCComInit größer COM9 möglich.
02.02.05 02.00.21 Die Funktion DFCGetFirmwareVersionFromFile zum auslesen der Firmwareversion aus einer Gerätedatei hinzugefügt. 
Bootloaderversion 2.2 wird unterstützt.
18.02.05 02.00.22 Die Listengröße ist auf ca. 256kByte erhöht worden. Die Listendaten können in dieser Größe mit der Funktion DFCMakeListe importiert werden. Beim Einspielen der Listendaten mit DFCLoadListen wird aufgrund der Firmwareversion eventuell der Fehler 13 zurückgeliefert, dann wird die Listengröße von der Firmwareversion nicht unterstützt.

Die Funktionen DFCListBDatensatz, DFCListBFeld wurden so überarbeitet, daß auch die Struktur der Zutrittskontrolllisten Version 1 abgefragt werden kann.
02.03.06 02.00.23 Die Funktionen DFCReadRecord, sowie DFCQuitRecord wurden nach aussenhin freigelegt. Die Funktionen DFCComCollectData und DFCComGetDatensatz verwenden diese intern und können durch diese ersetzt werden.
 Version 4.1 Die Version 3.x und 4.0 wurden nicht vergeben, damit eine Versionsgleichheit mit der aktuellen Firmware und dem DatafoxStudioIV entsteht. 
Die neuen Funktionen der Version 4.1 werden vom AEIII+ nicht mehr unterstützt.
27.06.06 04.01.01 Funktionen für die Zutrittskontrolle Version 2 hinzugefügt:
DFCClearEntrance2ListBuffer, DFCMakeEntrance2List, DFCLoadEntrance2List

Die Funktionen DFCListBDatensatz, DFCListBFeld wurden so überarbeitet, dass auch die Struktur der Zutrittskontrolllisten Version 1 / Version 2 abgefragt werden kann.

Die Funktionen DFCOpenTable, DFCCloseTable, DFCSetFilter, DFCGetFilter, DFCClearFilter, DFCSkip, DFCSetField, DFCGetField wurden hinzugefügt um auf Listenspalten zuzugreifen und deren Werte zu ändern.
11.08.06 04.01.02 Importierbare Listengröße für FW 04.00.xx wurde falsch bestimmt. 
Der CallBack - Aufruf bei Verwendung der FW 04.01.xx wurde nicht bei jeder Kommunikationsfunktion durchgeführt. 
Die Listenspeicher für Standard- sowie Zutrittslisten werden dynamisch verwaltet. Die Standard- sowie Zutrittslisten werden, wenn gefordert, vor der Übertragung lexikografisch sortiert. 
Die Funktion DFCComSendInfotext wurde für den BDE- /MDE-MasterIV aktiviert.
13.12.06 04.01.03 siehe entsprechende Einträge im Dokument "MasterIV, SoftwareVersionen Stand xxxx.xx.xx.pdf"
10.04.08 04.01.04 Erweiterung um die Funktionen DFCGetInfo, DFCEntrance2Identification, DFCOpenComServerMode, DFCCloseComServerMode, DFCFingerprintAppendRecord, DFCFingerprintGetRecord, DFCFingerprintDeleteRecord, DFCMakeTimeboyList, DFCLoadTimeboyList, DFCClearTimeboyListBuffer.
Die Funktion DFCUpload zum einspielen der Firmwaredateien, akzeptiert (in Win32) spezielle Zip-Archive. Unter Linux kann ein Verzeichnis angegeben werden.
22.10.08 04.01.05 Erweiterung um die Funktionen DFCStartActiveConnection, DFCStopActiveConnection, DFCGetFirstActiveChannelID, DFCGetNextActiveChannelID, DFCGetInfoActiveChannel, DFCSetRecordAvailable, DFCRecordAvailable, DFCModifyStudioFile, DFCEntrance2OnlineAction, DFCUploadModule.
Ab dieser Version wird die Aktive Verbindung für Win32 unterstützt.
16.03.09 04.01.06 Erweiterung der Funktionen DFCUpload um die Möglichkeit Textdaten zur Firmware einzuspielen. Funktion DFCRestoreRecords zum Wiederherstellen von Datensätzen hinzugefügt. Funktionen DFCGetOptionFirmware und DFCSetOptionFirmware hinzugefügt.
22.01.10 04.01.07 Funktion DFCReset zum auslösen eines Warmstarts hinzugefügt. Funktion DFCSetFontType zum verändern der Schriftart bei angezeigten Nachrichten, hinzugefügt. Funktionen DFCSetPassword, DFCGetPasswordKey für das Kommunikationspasswort, hinzugefügt. Funktion DFCPressVirtualKey zum virtuellen drücken von Tasten, hinzugefügt. Funktion DFCFingerprintList zum erstellen einer Liste, die alle enthaltenen PID-FID-Kombinationen des Fingerprintmoduls enthält. Funktionen DFCFingerprintBackup und DFCFingerprintRestore zum erstellen und wiedereinspielen von Backups, hinzugefügt. Funktion DFCGetFlashStatus zum Abrufen des Zustandes vom Hauptspeicherbaustein hinzugefügt.

 

1.4     Funktionsweise der DLL

Die DLL ist die Schnittstelle zwischen einer Softwareanwendung und den AEIII+ / MasterIV - Geräten. Alle die Geräte betreffenden Aufgaben werden von der Softwareanwendung an die DLL übergeben, dort verarbeitet und gegebenenfalls an das anzusprechende Gerät weitergeleitet.

Behandlung von Datensätzen

Um Datensätze aus den Geräten zu lesen muss zuerst die jeweilige Kommunikationsschnittstelle mit einer der Funktionen DFCComOpenSerial, DFCComOpenSocket (AEIII+) oder DFCComOpenIV (MasterIV) erfolgreich initialisiert werden. Danach wird mit der Methode DFCComCollectData das Gerät mit der angegebenen Busnummer bekannt gegeben und der erste Datensatz (oder alle Daten, je nach Firmwareversion) aus dem Gerät gelesen. Die Funktion DFCComGetDatensatz bestätigt diesen zuvor durch DFCComCollectData ausgelesenen Datensatz, übergibt die Daten in den zur verfügung zu stellenden Datenpuffer und liest den ggf. nächsten Datensatz aus dem Gerätespeicher aus. Dieser wird dann bei dem nächsten Aufruf von DFCComGetDatensatz quittiert und in den Datenpuffer übergeben. Auf diese Weise werden durch folgeaufrufe der Funktion DFCComGetDatensatz einzelne Datensätze aus dem Gerät an die Anwendung übergeben. Nach Ausführung aller benötigten Kommunikationsbefehle, muss mit der Funktion DFCComClose die Kommunikationsschnittstelle wieder geschlossen werden.
Es kann während der Kommunikation kein Datensatz verloren gehen, bei einer Störung während der Kommunikation kann es jedoch vorkommen das ein Datensatz zweimal ausgelesen wird (Aussage gilt für Firmwareversion > 2.0).

Die Datensätze werden ab der Firmwareversion 03.01.20 beim AEIII+ sowie 04.00.21 beim PZE-MasterIV in der chronologischen Reihenfolge geliefert.

Anmerkung zur Datensatz- und Listenbeschreibung (Tabellendefinitionen)
Es können gleichzeitig mehrere Verbindungen, so genannte Kanäle, unter verwendung verschiedenen Schnittstellen aufgebaut werden. Für jeden Kanal wird ein eigener interner Speicherbereich verwendet, der jedoch die Datensatzbeschreibungen und Listenbeschreibungen des zuletzt mit DFCLoadDatensatzbeschreibungausgelesenen Gerätes ( und DFCLoadListenbeschreibung) vorhält. D. h., wenn Sie verschiedene Setupkonfigurationen in den Geräten verwenden, ist eine Aktualisierung der Datensatz- und Listenbeschreibungen erforderlich.
Bei offen gehaltenen Kanälen ist folgendes zusätzlich zu beachten.
Wenn die Verbindung zwischen der DLL und dem Gerät unterbrochen wurde, dann sollte dieses durch die Fehlerbehandlung auf folgende Weise abgefangen werden (siehe auch 1.2 Exemplarischer Programmaufbau).

1.5     Allgemeine Hinweise

Der C-Compiler dekoriert die in den Funktionsprototypen angegebenen Namen. Vor den Namen wird das Zeichen "_" gesetzt und an den Namen wird die Anzahl der übergebenen Parameter in Längen - Byte durch "@" getrennt angehängt. Zusätzlich zum Funktionsprototyp werden daher auch die dekorierten Namen angegeben. Sie werden z.B. bei Verwendung von Visual Basic oder Delphi zum Import benötigt.

Beim Arbeiten mit der DLL ist es unter Umständen hilfreich, das Tool "Depends" oder "Dependency Walker" einzusetzen. So können alle in der DLL vorhandenen Funktionen und die erwarteten Parameterbytes angezeigt werden. Dieses Tool ist im Umfang von Visual Studio 6.0 enthalten. Dieser Export ist weiter unten bei jeder Funktion angegeben.

Die Datei DFComDll.lib muss in den Projekteinstellungen bei den Optionen "Link" in Visual C++ Projekten bei den Objekt / Bibliothek-Modulen eingetragen sein und beim Kompilieren des Projektes im Projektverzeichnis liegen (oder in dem in den Einstellungen eingestellten Pfad). Bei der Programmierung in C++ kann die Headerdatei aus dem Beispielcode verwendet werden. Auch für Visual Basic ist ein Modul mit den notwendigen Exportangaben vorhanden.

1.5.1     Listen des Setups

Speicherverwaltung der Listen

Jeder Kanal verwaltet seinen eigenen Speicher für die 20 möglichen Listen. Für jede zu importierende Liste wird entsprechend ihrer Größe ein dynamischer Speicher reserviert. Mit der Funktion DFCClrListenBuffer werden alle reservierten Speicher im entsprechenden Kanal freigegeben.

Achtung: 
Bitte beachten Sie, daß in den MasterIV-Geräten ein Flashspeicher zum Einsatz kommt. Laut dem Hersteller kann jeder Speicherblock (512Byte) maximal 100.000 mal beschrieben werden. Die Firmware der Geräte verteilt die Zugriffslast auf die einzelnen Speicherblöcke und markiert intern defekte Blöcke. Es ist jedoch trotz dieses Sicherheitsmechanismus von all zu häufiger Übertragung der Listendaten abzuraten. Die Applikation sollte nur bei Änderungen die Listen neu übertagen und nicht zyklisch permanent.
Übertragen von Listen

Die Verarbeitung erfolgt in zwei Schritten. Zuerst wird der DLL interne Speicher durch einen Aufruf der Funktion DFCMakeListe für jede Liste mit Listendaten gefüllt. Danach werden die Listendaten durch Aufruf der Funktion DFCLoadListen in das Gerät übertragen. Zu beachten ist, dass alle im Setup definierten Listen nacheinander mit der Funktion DFCMakeListe in den Speicher der DLL übertragen werden. Durch Aufruf der Funktion DFCLoadListen werden dann alle zuvor importieren Listen auf einmal übertragen und alle entsprechend alten Listen im Gerät automatisch gelöscht.

Achtung: 
Zwischen der Übertragung von Listen muss ggf. eine Wartezeit eingehalten werden. Hierzu siehe Abschnitt: Beschreibung der Übernahme von Listen
Übertragen einzelner Listen

Um eine einzelne Liste zu übertragen importieren Sie diese mit DFCMakeListe und übertragen sie dann mit DFCLoadListen. Die Funktion DFCLoadListen überträgt immer alle zuvor importierten Listen, egal ob eine oder mehrere.

Achtung: 
Das Laden einzelner Listen ist bei der MasterIV - Serie erst ab Firmwareständen >= 04.01.00 möglich. Beim AEIII+ müssen immer alle Listen übertragen werden, das Laden einzelner Listen ist nicht möglich.
Achtung: 
Zwischen der Übertragung von Listen muss ggf. eine Wartezeit eingehalten werden. Hierzu siehe Abschnitt: Beschreibung der Übernahme von Listen
Löschen von Listen

Es ist nicht möglich einzelne Listen komplett zu entfernen. Dies geschieht lediglich nach Übertragung einer Setupdatei. Durch Aufruf der Funktion DFCMakeListe mit der Datensatzanzahl 0 wird die Liste in der DLL als Leere Liste importiert und durch Aufruf der Funktion DFCLoadListen wird diese dann übertragen.

Beschreibung der Übernahme von Listen

Beschreibung wie die Listenübernahme der Firmware arbeitet. Die Listenübernahme des Setups ist je nach gewähltem Betriebsmodus "Normal, MDE" oder "PZE Modus 1, 2" leicht verschieden.

Listen für Betriebsmodus "Normal, MDE"

Nach übertragen einer oder mehrerer Listen, werden diese in folgenden Situationen übernommen:

Listen für den Betriebsmodus "PZE Modus 1, 2"

Zusätzlich zu den Situationen des Betriebsmodus "Normal, MDE", die hier auch gelten, kommt noch der einstellbare Tastentimeout dazu. Erfolgt keine Bedienung des Geräts für den eingestellten Tastentimeout, durchläuft das Gerät zwangsläufig das Hauptmenü und die Listendaten werden dadurch übernommen.

Listen für die Zutrittskontrolle

Nach übertragen einer oder mehrerer Zutrittslisten wird die Zutrittskontrolle gestoppt und die Listendaten in das System übernommen. Danach nimmt die Zutrittskontrolle ihren Betrieb wieder auf.

Listen für Timeboys

Nach übertragen einer oder mehrerer Listen für Timeboys, werden diese sofort übernommen, sofern nicht gerade eine Übertragung der bereits vorliegenden Listen in einen Timeboy aktiv ist. Dann wird die aktuelle Übertragung zuerst abgeschlossen bevor die neuen Listendaten übernommen werden.

Beim AEIII+ sowie MasterIV Firmwareversionen < 04.01.00

Hier müssen immer alle definierten Listen des Setups importiert und übertragen werden.

Der DLL interne Puffer wird für jede "ComNum" getrennt geführt. Die Listendaten müssen daher auch für jede verwendete "ComNum" getrennt aufgebaut werden. 

Wenn an einer "ComNum" mehrere Geräte angeschlossen sind, die unterschiedliche Listen benötigen, müssen die Listendaten vor der Übertragung zu der entsprechenden Busnummer, deren Gerät eine unterschiedene Listenstruktur hat, neu in den Puffer der DLL geladen werden.

Ablauf des Listenladen:

Testsoftware für die Listen liegt in folgenden Dateien bei: 

Die Testliste besteht aus den 3 Namen: 
Mueller, Maier und Schmidt mit den Personalnummern: 101, 102 und 103.

1.5.2     Datentypen

Die Datentypen werden meist ohne Vorzeichenbehaftung genutzt ( unsigned ).
Es werden folgende Datentypen verwendet:

Type Beschreibung
int Ganze Zahl 4 Byte
char Ein Zeichen entspricht einem Byte
int* Zeiger auf einen int. Umfasst 4 Byte
char* Zeiger auf Zeichen (Array). Umfasst 4 Byte.
unsigned char* Zeiger auf Datenbyte (Array). Umfasst 4 Byte.

1.5.3     Fehler

Die meisten Funktionen bieten eine Fehlerauswertung über das Error Argument nach folgender Tabelle, nachdem sie mit einer "if (DFCxxx == 0)" Abfrage gescheitert sind.
Folgende Fehler können im Error-Parameter auftreten:

Nummer
(in Var. "Error") 		 Bedeutung
0 Kein Fehler angegeben.
1 CRC (Prüfsumme) von Daten falsch.
2 Serielle Schnittstelle kann nicht geöffnet werden.
z.B.: belegt durch anderes Programm oder Kanal.
3 Der Kanal ist für die benötigte Kommunikation noch nicht geöffnet worden.
4 Allgemeiner Fehler bei Kommunikation mit AEIII+ / MasterIV.
5 AEIII+ / MasterIV antwortet nicht auf Anfrage.
6 Fehler beim Senden eingetreten.
7 Fehler beim Empfangen eingetreten.
8 Antwort vom falschen Gerät oder im Kontext nicht sinnvoll.
9 Die verwendete Busnummer ist ungültig. Wertebereich: (1 - 31, 254)
10 Kanalobjekt nicht vorhanden. Kanalobjekt nicht herstellbar. Wertebereich: (1 - 250)
11 Öffnen einer Datei gescheitert. Meist nicht vorhanden.
12 Falsches Format der Setupdaten. Meist bezieht sich dies auf das Setup.
13 Fehler bei Verarbeitung der Listendaten.
14 Firmwareversion vom anzusprechenden Gerät ist nicht Kompatible.
15 Es sind noch Datensätze im Gerät vorhanden, welche unbrauchbar würden.
16 Befehlsausführung wurde durch Anwender abgebrochen.
17 Es ist keine Datensatzbeschreibung im entsprechenden Kanal geladen.
18 Es ist keine Listenbeschreibung im entsprechenden Kanal geladen.
19 Fehler beim Programmieren des Flash, Firmware. 
20 Parameter einer Funktion außerhalb ihres Gültigkeitsbereiches.
21 Globale Variable nicht definiert.
22 Anfrage obwohl keine Daten.
23 Duplikat von Datensätzen abgefangen.
24 Gerätedatei nicht mit Bootloaderversion kompatible.
25 Firmwaredatei nicht mit Bootloaderversion kompatible.
26 Wert einer Variablen konnte nicht gesetzt werden.
27 Funktion steht im vorliegenden Fall nicht zur Verfügung.
28 Fehler in Applikationsschicht bei Befehlsausführung.
(Der Befehl wurde erfolgreich zwischen dem Gerät und der DLL übertragen, die geforderte Ausführung konnte jedoch nicht erfolgen. z. B. unterstützt das Gerät die geforderte Funktion nicht oder ist augenblicklich nicht bereit die Funktion auszuführen.)
29 Der Gerätetyp ist unbekannt. Update der Software erforderlich.
30 Die angegebene Geraetedatei stimmt nicht mit der vorliegenden Hardware ueberein. Oder aber, es liegt keine passende Gerätedatei für die vorliegende Hardware im Zip-Archiv vor. Kommt bei DFCUpdate zur Anwendung.
31 Gerätetyp stimmt nicht. 
z.B. Versuchtes Einspielen von Setupdatei für PZE-MasterIV in BDE-MasterIV
32 Die vorliegende Dateiendung wird nicht unterstützt.
33 Der Tabellenname oder Spaltenname ist undefiniert.
34 Ein angegebener Handle ist nicht gültig.
35 Der anzuwendende Filter würde keine Datensätze liefert.
36 Sprung führte zum Anfang der Tabelle. (Base of File)
37 Sprung führte zum Ende der Tabelle. (End of File)
38 Der angegebene Wert ist Fehlerhaft.
39 Die Zutrittskontrolle ist deaktiviert.
40 Bei einer Datenübertragung ist ein Speicherüberlauf eingetreten.
41 Es liegen keine Daten vor.
42 Der Befehl konnte zwar übermittelt werden, bei den Daten liegt jedoch ein fehler vor.
43 Das angesprochene Modul ist zur Zeit durch einen anderen Process blockiert.
44 Fehler beim Laden einer XML-Datei.
45 Unbekannte Elemente in einer XML-Datei.
46 Fehlerhafter Dateninhalt einer XML-Datei.
47 Fehler beim Übernehmen oder Anwenden der Daten.
48 Speicherallokation konnte nicht durchgefuehrt werden.
49 Diese Version der Geraetedatei kann aufgrund ihrer Aktualität nicht verarbeitet werden.
50 Bei der Verarbeitung der Dateidaten trat ein Fehler auf.
51 Die vorliegende Geraetedatei passt nicht zur vorliegenden Hardware. Oder aber: Im Archiv wurde keine passende Gerätedatei gefunden.
52 Fehler beim Laden der Gerätedatei(archive) aufgetreten.
53 Die Aktive Verbindung ist gestartet.
54 Die Aktive Verbindung ist nicht gestartet.
55 Der angegebene Listensocket ist bereits in Verwendung.
56 Die Aktive Meldung von Datenätzen ist deaktiviert.
57 Allgemeiner Fehler beim Starten der Aktiven Verbindung.
58 Das angegebene Passwort stimmt nicht mit dem benötigten überein. Es wird ein Passwort gefordert.
59 Gerät ist aufgrund von fehlerhaften Passworteingaben für 60 Sekunden gesperrt.
60 Das Schreiben in die Datei ist fehlgeschlagen.
61 Das Lesen aus der Datei ist fehlgeschlagen.
62 Fehlerhafter Dateninhalt. Die Prüfung auf die Datenkonsistenz per CRC schlug fehl.
63 Es steht kein weiterer Speicherplatz zur Verfügung. Z. B. kann die maximale aufnehmbare Anzahl Fingertemplates erreicht sein.
64 Die in der Datei vorliegenden Daten stimmen nicht mit den geforderten überein. Z. B. in der Datei liegen Fingertemplates vom Typ Idencom-Compact vor, es werden jedoch DIN Erfordert.
65 Es steht nicht genügend Flash-Speicher zur Verfügung, um die Daten aufzunehmen.
66 Das von Ihnen angesprochene Modul ist eine Optionale Hardware-Erweiterung und ist im vorliegenden Gerät nicht verfügbar.

1.5.4     Hintergrundloggen

In der DLL ist ein Logmechanismus für ein Hintergrundloggen eingebracht, welches alle Funktionsaufrufe in Dateien (Standard: YYYY_MM_DD_DFComDLL_channelID.log) die in einem angelegten Ordner (Standard: DFComLog) liegen schreibt. Dieses Hintergrundloggen ist Standardmäßig aktiviert und kann über die Initialisierungsdatei "DFCom.ini" gesteuert werden. Es werden die letzten fünf aufeinanderfolgenden Anwendungstage mitgeschnitten und die so gesammelten Daten umfassen im Mittel ein Datenvolumen von ca. 300MB.

Aufbau der Logeinträge
Durch den Dateinamen ist das Datum und der Kanal bekannt. Die Zeit des Funktionsaufrufes ist die erste Logangabe. Danach folgt durch Tabstopp getrennt der Funktionsname mit den jeweils übergebenen Parameterwerten. Als Abschluss wird der Rückgabewert (wenn vorhanden) in Klammern angegeben. Bei Parametern die über Zeiger bekannt gegeben werden, wie Fehlerobjekt oder Datenbuffer, werden immer die Übergebenen Werte nicht die Adresse mitgeschrieben. Wenn keine Werte Vorliegen werden trotzdem immer alle Tabstopp ausgegeben und es ist somit möglich die Datei für eine weitere Verarbeitung zu verwenden. In einer Eckigen Klammer wird nach setzen des Elapse - Schlüssels die Ausführungsdauer der Funktion angegeben, diese gibt an wie lange die DLL - Funktion für die Abarbeitung des Befehls benötigte (Stark abhängig von den verwendeten Schnittstellentimeouts).
 Beispiel: 2007_02_05_DFComDLL_1.log
11:14:57	DFCComOpenSerial	1	COM1	38400	150	(1) [0.1]
Initialisierungsdatei
Der zu Verwendende Dateiname lautet: DFCom.ini

Bedeutung der Schlüsselwerte in der Sektion Log:

 Beispiel:
[Log]
Enable=1
Path=.\
Folder=DFComLog
Trace=0
Erase=1
Keep=10
Elapse=1
List=1

1.5.5     Uhrzeit stellen

Die Uhr in den Terminals sollte regelmäßig gestellt werden, um Abweichungen zu vermeiden. Insbesondere, wenn mehrere Terminals verwendet werden. Wir empfehlen die Uhr mindestens einmal pro Tag zu stellen. Der ideale Zeitpunkt dafür ist 4:00 Uhr, da hier dann bei Sommer-/Winterzeit gleich die Uhr richtig gestellt wird.
Die Firmwareversionen unter 04.00.23 haben keine automatische Sommer-/Winterzeitumstellung. Hierfür ist die Anwendung verantwortlich. 
Es ist ggf. die automatische Sommer-/Winterzeitumstellung des Betriebssystems zu aktivieren.

Zum stellen der Uhr verwenden Sie die Funktion DFCComSetTime.

1.5.6     Timeboylisten übertragen

 Achtung: 
Dieses Feature gilt erst ab MasterIV-Firmwareversion 04.01.04 und nur für TimeboyIII-Geräte. Ebenfalls muss Ihr MasterIV-Gerät mit der Option, Timeboygeräte anzusprechen ausgestattet sein.
Der Speicherbedarf der Timeboylisten, reduziert den Speicherplatz für die MasterIV-Listen.
GroupID

Ist eine im Timeboy hinterlegte Nummer. Standardmäßig ist diese 0 und kann über das TbSetup gesetzt werden. Timeboys können über diese Nummer in Gruppen eingeteilt werden und über die DLL-Funktionen mit separaten Listen Versorgt werden.
Beispiel zur Erklärung:
Problem: Sie haben drei Timeboys mit dem gleichen Setup im Einsatz, möchten aber auf jedem Timeboy eine eigene Auftragsliste aufspielen.
Lösung: Sie Vergeben jedem Timeboy eine eigene GroupID und übertragen die Listen, die für alle Geräte gültig sind mit der GroupID 0 und die jeweilige Auftragsliste mit derren GroupID.

1.5.7     Übertragen von Gerätedateien (DFCUpload)

 Beim PZE-MasterIV zu beachten 
Um ein Update von einer Firmwareversion kleiner 04.00.23.769 auf eine Version >= 04.01.xx durchzuführen, muß zuvor eine Version der Reihe 04.00 >= 04.00.769 eingespielt werden.
Ein Downgrade von der Versionsreihe 04.01 oder höher, auf die Versionsreihe 04.00, ist aufgrund einer möglichen Inkompatibilität zur eingesetzten Hardware, vorher zu prüfen und ggf. zu vermeiden.
Das Aufspielen einer Firmwareversion der Reihe 04.00 darf nur auf PZE-MasterIV mit einer Revision 2.0 geschehen. Die Revision können sie dem Typenschild entnehmen, dabei fehlt die Revisionsangabe hinter der Gerätebezeichnung, wenn sie 2.0 ist.
Im Beispiel links ist die Revision rot umrahmt.
 Beim Update über Gerätedateiarchiv (*.dfz) ist folgendes zu beachten. 
Folgende Optionen können mitlerweile zusätzlich durch den Anwender eingestellt werden:
  • Externe Leserserie (PHG oder Datafox)
  • IOModul an Gerät angebunden.
  • Timeboy an Gerät angebunden.
  • Vorhandenes Setup und Listen nach Fimrwareupdate beibehalten. (Nur Mobil-MasterIV)
Diese Informationen werden (so weit vorhanden) von der Updateroutine herangezogen um die gewünschte Gerätedatei aus dem Gerätedateiarchiv (*.dfz) auszuwählen.

Von folgenden Einstellungen geht die DLL aus, wenn die Optionen im Gerät undefiniert sind.
  • Externe Leserserie: Datafox
  • IOModul an Gerät angebunden: Nein
  • Timeboy an Gerät angebunden: Beim Mobil-MasterIV: Ja, ansonsten Nein.
  • Vorhandenes Setup und Listen nach Fimrwareupdate beibehalten. (Nur Mobil-MasterIV): Nein
Beim Update über das DatafoxStudioIV werden Sie automatisch zur Einstellung der Optionen aufgefordert, wenn diese undefiniert sind. Beim Update über die DLL werden die oben aufgeführten Standardvorgaben verwendet. Die Umschaltung der Optionen ist über das DatafoxStudioIV möglich.
 Allgemeine Hinweise zu allen MasterIV-Geräten 
Das Wechseln in den Bootloadermodus ist im jeweiligen Handbuch beschrieben.
Im Bootloadermodus verwendet das Gerät fest die Kommunikationsart RS232.
Nach Aufspielen einer Firmwareversion über den Bootloadermodus, wird von der aufgespielten Firmwareversion nach Neustart, die vor dem Wechsel in den Bootloadermodus gewählte Kommunikationsart verwendet.
Ein Downgrade ist generell über den Bootloadermodus durchzuführen.
Nach Aufspielen einer Firmwareversion über GSM/GPRS, führt das Gerät eine Neueinwahl mit den zuvor verwendeten Einwahldaten durch. Diese gehen durch das Aufspielen einer Firmwareversion nicht verloren.
Die Setupdatei und Listendaten müssen nach jedem Aufspielen einer Firmwareversion neu übertragen werden. Einzige Ausnahme ist das Mobil-MasterIV mit einer Version >= 04.01.04.53 und gesetzter Option zum Halten der Daten.
 Bekannte Probleme und deren Fehlerbehebung 
Nach Übertragung einer Firmwareversion werden bei Geräten mit Anzeige, keine Schriften und Grafiken angezeigt. Übertragen Sie die gleiche Fimrwareversion bitte nochmals.

1.5.8     IP-Adresse und Hostname

Angabe einer IP-Adresse in Punktnotation:
IP-AdresseBeschreibung
"4.3.2.16"Dezimale Angabe
"004.003.002.020"Oktale Angabe
"0x4.0x3.0x2.0x10"Hexadezimale Angabe
"4.003.002.0x10"Mix
Bitte beachten Sie, dass vornullen zur Oktalen Angabe führen!!

Die Angabe von Hostnamen. Z. B.: www.datafox.de

1.6     Aktive Verbindung

1.6.1     Einleitung

Im nachfolgenden Dokument wird kurz Erläutert wie das Konzept der "Aktiven Verbindung" funktioniert und eingesetzt werden kann. Es bezieht sich auf die Version 4.1.5 der Firmware, DFComDLL und DatafoxStudioIV.

1.6.2     Grober Überblick

Bei der "Aktiven Verbindung" bauen die Geräte eine Verbindung zur DLL auf. Diese Verbindung bleibt über die gesamte Laufzeit bestehen und wird durch Alive-Pings sichergestellt. Das Bedeutet, dass bei einem Verbindungsabriss oder einer Verbindungsunterbrechung die Geräte selbstständig eine Neuverbindung unternehmen.

Jede bestehende "Aktive Verbindung" hat eine eindeutige Kanalnummer die über die entsprechenden DLL Funktionen abgerufen werden können. Unter Verwendung dieser Kanalnummer kann jede DLL Funktion wie gewohnt ausgeführt werden. Die Busnummer ist in diesem Fall immer 254.

Zusätzlich zur "Aktiven Verbindung" kann eine "Aktive Datensatzmeldung" konfiguriert werden. Dabei melden die Geräte der DLL ob Datensätze vorliegen.

1.6.3     Kurze Gegenüberstellung der Befehlsausführung ohne und mit "Aktiver Verbindung"

DLL ohne "Aktive Verbindung"

  1. DFCComOpenIV für den Verbindungsaufbau aufrufen
  2. Gewünschten Befehl ausführen. Z.B. DFCGetSeriennummer
  3. DFCComClose für den Verbindungsabbau aufrufen
DLL mit "Aktive Verbindung"
  1. DFCGetFirstActiveChannelID, DFCGetNextActiveChannelID, DFCGetInfoActiveChannel für die Geräteermittlung aufrufen.
  2. Gewünschten Befehl ausführen. Z. B. DFCGetSeriennummer

1.6.4     Starten Stoppen und Initialisieren der "Aktiven Verbindung"

Über die DLL Funktion DFCStartActiveConnection starten Sie das DLL - Modul für die "Aktive Verbindung". Dabei wird von der DLL ein Listen-Socket erstellt, an den die Geräte dann eine Verbindungsanfrage stellen können. Mit DFCStopActiveConnection beenden Sie das DLL - Modul für die Aktive Verbindung, dabei werden alle bestehenden Verbindungen getrennt.

Im Gerät geschieht die Aktivierung / Deaktivierung durch die Systemvariable COM.ACTIVE.

Die im Gerät zu hinterlegenden Verbindungsdaten können über Systemvariablen eingestellt werden. Eine Liste aller benötigten Systemvariablen für den Präfix COM finden Sie im Kapitel 4.7.

Systemvariablen können mit den DLL Funktionen DFCSetGlobVar, DFCGetGlobVar gesetzt bzw. gelesen werden.

Die Systemvariablen für Präfix COM, können über das DatafoxStudioIV eingestellt werden. Bitte beachten Sie den hierfür zuständigen Dialog unter "Kommunikation -> Aktive Verbindung - Konfiguration".

1.6.5     Melden von Datensätzen

Standardmäßig ist das Melden von Datensätzen nach dem Start der "Aktiven Verbindung" durch DFCStartActiveConnection aktiviert und die DLL verarbeitet somit die Meldungen der Geräte. Durch Aufruf der Funktion DFCSetRecordAvailable kann diese Meldungsverarbeitung der DLL aktiviert / deaktiviert werden.

Im Gerät geschieht die Aktivierung / Deaktivierung durch die Systemvariable COM.NOTIFY.

Wenn im Gerät mindestens ein Datensatz abrufbereit ist, wird dieses durch das Gerät der DLL automatisch gemeldet. Die Meldung wird in einer Prioritätswarteschlange der DLL eingereiht und kann über die Funktion DFCRecordAvailable abgerufen werden. Über diesen Funktionsaufruf wird unter anderem die "Aktive Kanalnummer" geliefert und kann zum Abrufen der Datensätze im folgenden Aufruf von DFCReadRecord verwendet werden.

1.6.6     Inbetriebnehmen und Testen

Die Aktive Verbindung sowie Melden von Datensätzen kann über das DatafoxStudioIV geprüft und in Betrieb genommen werden. Hierzu steht ein eigener Kommunikationspunkt unter "Kommunikation -> Einstellungen" zur Verfügung. Bitte beachten Sie, dass Sie bevor eine Kommunikation mit einem Gerät durchgeführt werden kann, ein Aktiver Kanal gewählt werden muss.

2.0     Exportierte Funktionen

Die nachfolgenden Funktionen werden von der DLL zur Verfügung gestellt.

2.1     Allgemeine Funktionen

Grundlegende Funktionen zum Verbindungsaufbau und Kommunikation sowie loggen des Verbindungsablaufs.

2.1.1.1     DFCComInit ( RS232 / RS 485 )

 Achtung: 
Diese Funktion ist ausschließlich für das AEIII+.
Sie ist aufgrund des verwendeten Timeout's für Modemverbindungen nicht einzusetzen.
Ruft intern die Funktion DFCComOpenSerial auf.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration: 
extern "C" __declspec(dllexport)
int __stdcall DFCComInit(int iChannelNum);

Exportiert: _DFCComInit@4
Parameter: 
int iChannelNum Zu initialisierender Kanal der die Schnittstelle (COM1, COM2, ...), entsprechend seiner Nummer verwendet.
Rückgabewert: 
0 Fehler beim Initialisieren (siehe auch Fehlerbehandlung und Exemplarischer Programmaufbau)
1 Schnittstelle initialisiert
Beschreibung: 
Initialisiert die serielle Schnittstelle ("COM1" - "COM4" oder "/dev/ttyS0" - "/dev/ttyS3") mit:
DFCComOpenSerial(iChannelNum, szCom, 38400, 150). Wobei szCom = "COM1" , usw.. ist.
Die Funktion muss bei Verwendung von RS232 bzw. RS485 erfolgreich aufgerufen werden, bevor mit den Kommunikationsfunktionen gearbeitet werden kann.

Ab der DLL - Version 04.01.00 wurde der Defaulttimeout von 150 auf 800 erhöht.

 

2.1.1.2     DFCComOpenSerial ( RS232 / RS 485 )

 Achtung: 
Diese Funktion ist ausschließlich für das AEIII+.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration: 
extern "C" __declspec(dllexport)
int __stdcall DFCComOpenSerial(int iChannelNum, char *szComPort,
int iBaudRate, int iTimeOut);

Exportiert: _DFCComOpenSerial@16
Parameter: 
int iChannelNum Zu initialisierender Kanal. Wertebereich: (1 - 250)
char *szComPort Zeichenkette für die Schnittstelle. "COM1" .. "COM4", 
"/dev/ttyS0" .. "/dev/ttyS3"
int iBaudRate Übertragungsrate der Schnittstelle in Baud. (Standard: 38400bd) 
int iTimeOut TimeOut für Lesen von Schnittstelle in Millisekunden. (Standard: 800ms) Bei Modem min. 1500ms empfohlen.
Rückgabewert: 
0 Fehler beim Initialisieren (siehe auch Fehlerbehandlung und Exemplarischer Programmaufbau)
1 Schnittstelle initialisiert
Beschreibung: 
Initialisiert den Kanal für die serielle Schnittstelle (COM1 - COM4).
Die Funktion muss bei Verwendung von RS232 bzw. RS485 erfolgreich aufgerufen werden, bevor mit den Kommunikationsfunktionen gearbeitet werden kann.

 

2.1.1.3     DFCComOpen ( TCP/IP )

 Achtung: 
Diese Funktion ist ausschließlich für das AEIII+.
Nach einem Verbindungsabriss wird keine automatische Neuverbindung durchgeführt. Bitte beachten Sie hierzu die Fehlerbehandlung und unter Exemplarischer Programmaufbau beschriebene Umsetzungslösung.
Ruft intern die Funktion DFCComOpenSocket auf.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration: 
extern "C" __declspec(dllexport)
int __stdcall DFCComOpen(int iChannelNum, char *szHost);

Exportiert: _DFCComOpen@8
Parameter: 
int iChannelNum Nummer des Kanals. Wertebereich: (1 - 250)
Die Kanalnummer dient dazu die TCP/IP-Verbindung bei weiteren Befehlen zu identifizieren. Wenn auch gleichzeitig RS232-Verbindungen verwendet werden, darf sich die Nummer nicht mit einer verwendeten Com - Nummer überschneiden.

Beispiel: 
In einem Rechner werden COM1: und COM2: verwendet.
Dann sollten für TCP/IPVerbindungen die Nummern 3, 4, 5, ... 10 verwendet werden.
char *szHost IP-Adresse ( z.B. "192.168.123.99") oder Hostname.
Rückgabewert: 
0 Fehler beim Initialisieren (siehe auch Fehlerbehandlung und Exemplarischer Programmaufbau)
1 Schnittstelle initialisiert.
Beschreibung: 
Initialisiert den Kanal für die Socket (TCP / IP) Schnittstelle zum Com - Server. mit:
DFCComOpenSocket(iChannelNum, szHost, 8000, 3000).
Die Funktion muss bei Verwendung von TCP / IP erfolgreich aufgerufen werden, bevor mit den Kommunikationsfunktionen gearbeitet werden kann.

Ab der DLL - Version 04.01.00 wurde der Defaulttimeout von 3000 auf 5000 erhöht.

 

2.1.1.4     DFCComOpenSocket ( TCP/IP )

 Achtung: 
Diese Funktion ist ausschließlich für das AEIII+.
Nach einem Verbindungsabriss wird keine automatische Neuverbindung durchgeführt. Bitte beachten Sie hierzu die Fehlerbehandlung und unter Exemplarischer Programmaufbau beschriebene Umsetzungslösung.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration: 
extern "C" __declspec(dllexport)
int __stdcall DFCComOpenSocket(int iChannelNum, char *szRemoteIP,
int iPortNum, int iTimeOut);

Exportiert: _DFCComOpenSocket@16
Parameter: 
int iChannelNum Nummer des Kanals. Wertebereich: (1 - 250)
Die Kanalnummer dient dazu die TCP/IP-Verbindung bei weiteren Befehlen zu identifizieren. Wenn auch gleichzeitig RS232-Verbindungen verwendet werden, darf die Nummer nicht mit einer verwendeten Com - Nummer identisch sein.

Beispiel: 
In einem Rechner werden COM1: und COM2: verwendet.
Dann sollten für TCP/IPVerbindungen die Nummern 3, 4, 5, ... 10 verwendet werden.
char *szRemoteIP IP-Adresse in Punktnotation oder Hostname.
int iPortNum Portnummer des COM - Server. W&T-Standard: 8000
int iTimeOut TimeOut für lesen von Schnittstelle in Millisekunden. (Standard: 5000ms)
Rückgabewert: 
0 Fehler beim Initialisieren (siehe auch Fehlerbehandlung und Exemplarischer Programmaufbau)
1 Schnittstelle initialisiert.
Beschreibung: 
Initialisiert den Kanal für die Socket (TCP / IP) Schnittstelle zum Com - Server. 
Die Funktion muss bei Verwendung von TCP / IP erfolgreich aufgerufen werden, bevor mit den Kommunikationsfunktionen gearbeitet werden kann.

 

2.1.2     DFCComOpenIV ( RS232 / RS 485 / Funk( BIM2 ) / TCP-IP )

 Achtung: 
Diese Funktion ist ausschließlich für die MasterIV-Serie.
Nach einem Verbindungsabriss wird keine automatische Neuverbindung durchgeführt. Bitte beachten Sie hierzu die Fehlerbehandlung und unter Exemplarischer Programmaufbau beschriebene Umsetzungslösung.
Die Funktion initialisiert den Kanal zur Verwendung mit einem Multimaster - Protokoll. Sie können dadurch kein AEIII+ und MasterIV in ein und dem selben RS485 - Netzwerk betreiben, da dass AEIII+ mit einem zum MasterIV nicht kompatiblen Protokoll arbeitet!
Wird unterstützt ab Firmwareversion:
04.00.00
Deklaration: 
extern "C" __declspec(dllexport)
int __stdcall DFCComOpenIV(int iChannelNum, int iBusNum, int iType,
char *szComString, int iComValue, int iComTimeOut);

Exportiert: _DFCComOpenIV@24
Parameter: 
int iChannelNum Zu initialisierender Kanal. Wertebereich: (1 - 250)
int iBusNum Die Busnummer der DLL. Multimasteransatz: Die DLL ist in einem Netzwerk ein Kommunikationsteilnehmer wie jedes Gerät und kann von diesen direkt angesprochen werden. Diese Busnummer muss im Netzwerk eindeutig sein und darf sich nicht mit der eines Geräts decken.
Wertebereich: (1 - 31, 254)
int iType Der zu verwendende Schnittstellentyp.
WertBedeutung
1RS232 direkt oder über Umsetzter (RS232 <-> RS485)
2Funk über den Umsetzer (RS232 <-> BIM2) ohne eigenen Kontroller.
3TCP / IP - Verbindung.
char *szComString Je nach Schnittstellentyp:
iTypeBedeutung
1, 2Zeiger auf Zeichenkette für die Schnittstelle.
3Zeiger auf Zeichenkette mit IP - Adresse oder Hostname.
int iComValue Je nach Schnittstellentyp:
iTypeBedeutung
1, 2Übertragungsrate der Schnittstelle in Millisekunden. (Standard: 38400bd)
3Portnummer des TCP / IP Anschlusses. (Standard: 8000)
int iComTimeOut Je nach Schnittstellentyp:
iTypeBedeutung
1, 2Timeout für Lesen von Schnittstelle in Millisekunden. (Standard: 800ms)
Bei Modem min. 1500ms empfohlen.
3Timeout für Lesen von Socket in Millisekunden. (Standard: 5000ms)
Rückgabewert: 
0 Fehler beim Initialisieren (siehe auch Fehlerbehandlung und Exemplarischer Programmaufbau)
1 Schnittstelle initialisiert.
Beschreibung: 
Initialisiert den Kanal. Je nach angegebenem Typ wird ein anderes Initialisierungsverfahren verwendet um die entsprechend nachfolgenden Funktionsaufrufe der exportierten Funktionen richtig umzusetzen.
Die Funktion muss aufgerufen werden, bevor mit den Kommunikationsfunktionen gearbeitet werden kann.

Achtung: Nach einem Verbindungsabriss (TCP / IP) wird keine automatische Neuverbindung durchgeführt. Bitte beachten Sie hierzu die Fehlerbehandlung und unter Exemplarischer Programmaufbau beschriebene Umsetzungslösung. 

 

2.1.3     DFCComClose

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCComClose(int iChannelNum);

Exportiert: _DFCComClose@4
Parameter: 
int iChannelNum Zu schließender Kanal. Wertebereich: (1 - 250)
Rückgabewert: 
keiner (siehe auch Fehlerbehandlung und Exemplarischer Programmaufbau)
Beschreibung: 
Schließt den Kanal der seriellen Schnittstelle bzw. der TCP / IP - Verbindung.

 

2.1.4.1     DFCCheckAE

Ruft intern die Funktion DFCCheckDevice auf.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCCheckAE(int iChannelNum, int iBusNum);

Exportiert: _DFCCheckAE@8
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
Rückgabewert: 
0 Fehler bei Durchführung. Es ist kein Gerät mit dieser Busnummer erreichbar.
(siehe auch Fehlerbehandlung und Exemplarischer Programmaufbau)
1 Die angegebene Busnummer ist erreichbar. 
Beschreibung:
Prüfen ob Gerät am Bus angeschlossen ist. Diese Funktion verwendet die DFCCheckDevice - Funktion.

 

2.1.4.2     DFCCheckDevice

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCCheckDevice(int iChannelNum, int iBusNum,
int *piError, int iDevicePollRetry);

Exportiert: _DFCCheckDevice@16
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
int iDevicePollRetry Wiederholungen zur Erreichbarkeit.
Rückgabewert: 
0 Fehler bei Durchführung. Es ist kein Gerät mit dieser Busnummer erreichbar, dabei behält der Fehlercode seinen zuvor übergebenen Wert.
(siehe auch Fehlerbehandlung und Exemplarischer Programmaufbau)
1 Die angegebene Busnummer ist erreichbar. 
Beschreibung:
Prüfen ob Gerät am Bus angeschlossen ist.

 

2.1.5     DFCComSetTime

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCComSetTime(int iChannelNum, int iBusNum,
unsigned char *pucDateTime);

Exportiert: _DFCComSetTime@12
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
unsigned char *pucDateTime Zeiger auf das Datum - Uhrzeit - Feld von 7 Byte. Für den genauen Aufbau siehe: Datum und Uhrzeit im ByteArray
Verwenden Sie eine DLL mit Versionsnummer größer 2.0.7 können Sie  hier NULL (Wert: 0) übergeben, wodurch die Routine das aktuelle Systemdatum und die aktuelle Systemzeit verwendet.
Rückgabewert: 
0 Fehler beim setzen der Uhrzeit.
1 Uhrzeit erfolgreich eingestellt.
Beschreibung: 
Stellt das Datum und die Uhrzeit des Gerätes.
 Beispiel:
27.02.1981 15:30:13
0 Jahreszahl Hunderter (0..255) 19
1 Jahreszahl Einer (0..99) 81
2 Monat (0..12) 2
3 Tag (1..31) 27
4 Stunde (0..23) 15
5 Minute (0..59) 30
6 Sekunde (0..59) 13 
// Die Schnittstelle zum Gerät muss natürlich geöffnet
// worden sein.
unsigned char Buffer[7];

Buffer[0] = 19;
Buffer[1] = 81;
Buffer[2] = 2;
Buffer[3] = 27; // 27.02.1981 Datum
Buffer[4] = 15;
Buffer[5] = 30;
Buffer[6] = 13; // 15:30:13 Uhrzeit

// Auf Fehler wird hier nicht geprüft !!! (siehe Rückgabewert)
// Senden des DatumUhrzeit - Array
// über Kanal 1 an Gerät mit Busnummer 2
DFCComSetTime(1, 2, Buffer);

 

2.1.6     DFCComGetTime

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCComGetTime(int iChannelNum, int iBusNum,
unsigned char *pucDateTime);

Exportiert: _DFCComGetTime@12
Parameter: 
int iChannelNum  Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
unsigned char *pucDateTime Zeiger auf ein Feld von min. 7 Byte, in das Datum und Uhrzeit geschrieben wird. Für den genauen Aufbau siehe: Datum und Uhrzeit im ByteArray
Rückgabewert: 
0 Fehler beim lesen der Uhrzeit.
1 Uhrzeit erfolgreich gelesen und in Feld "Time" abgelegt.
Beschreibung: 
Liest Datum und Uhrzeit des Geräts.
Beispiel:
27.2.1981 15:30:13
0 Jahreszahl Hunderter (0..255) 19
1 Jahreszahl Einer (0..99) 81
2 Monat (0..12) 2
3 Tag (1..31)  27
4 Stunde (0..23) 15
5 Minute (0..59) 30
6 Sekunde (0..59) 13 
// Die Schnittstelle zum Gerät muss natürlich geöffnet
// worden sein.
unsigned char Buffer[7];
Buffer[0] = 19;
Buffer[1] = 81;
Buffer[2] = 2;
Buffer[3] = 27; // 27.02.1981 Datum
Buffer[4] = 15;
Buffer[5] = 30;
Buffer[6] = 13; // 15:30:13 Uhrzeit

// Aktuelles Datum und Uhrzeit über Kanal 1 von Gerät
// mit Busnummer 2 ermitteln.
// Auf Fehler wird hier nicht geprüft !!! (siehe Rückgabewert)
DFCComGetTime(1, 2, Buffer);

// Daten ausgeben. 
printf("Jahr: %02d%02d\n", Buffer[0], Buffer[1]);
printf("Monat: %02d\n",    Buffer[2]);
printf("Tag: %02d\n",      Buffer[3]);
printf("Stunde: %02d\n",   Buffer[4]);
printf("Minute: %02d\n",   Buffer[5]);
printf("Sekunde: %02d\n",  Buffer[6]); 

 

2.1.7     DFCComSendMessage

 Achtung: 
Nachfolgend der Eintrag zu "Freigabe: 12.11.04, Firmwareversion 04.00.22 aus dem Dokument PZE-MasterIV, SoftwareVersionen Stand 2004-12-02.pdf"
  • Die SendMessage-Funktion wurde beim Online-Betrieb überarbeitet. Nach dem "online" abholen vom Server wird auf eine Message vom Server gewartet. Falls keine Message geschickt werden soll, muß man eine Dummy-Nachricht mit der Anzeigedauer von 0 Sekunden schicken, sonst bekommt der Benutzer am Terminal eine Fehlermeldung. SendMessage ist für Online-Betrieb erst mit dieser Version freigegeben.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCComSendMessage(int iChannelNum, int iBusNum,
unsigned char ucDelayTime, unsigned char ucAction,
unsigned char ucAudio, char *szMessage, int iLength);

Exportiert: _DFCComSendMessage@28
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum  Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
unsigned char ucDelayTime Dauer in Sekunden, während der die Meldung angezeigt werden soll. Beim AEIII+ kann durch Übergabe von 255 die Nachricht so lange angezeigt werden bis ein Bediener diese durch Enter oder ESC bestätigt.
AEIII+ Bereich (1 - 255)
AEIV Bereich (0 - 254)
unsigned char ucAction
WertBedeutung
0normal weiter
unsigned char ucAudio
WertBedeutung
0kein Piepser
1Einfachpiep
2Doppelpiep
char *szMessage Zeiger auf die darzustellende Zeichenkette. 
int iLength Zeichenlänge der Meldung. Maximal 242. 
(PZE-MasterIV, siehe Beschreibung)
Rückgabewert: 
0 Fehler beim Senden.
1 Meldung erfolgreich gesendet.
Beschreibung: 
Sendet eine Meldung an das Gerät mit der angegebenen Busnummer. 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.

Nur AEIII+
Das AEIII+ kann pro Zeile maximal 19 Zeichen darstellen, das zwanzigste ist für die Laufleiste reserviert. Bitte beachten Sie, daß Sonderzeichen sowie Umlaute durch den vorgegebenen Displayzeichensatz nicht richtig dargestellt werden können.
Wenn Sie einen Zeilenumbruch erreichen möchten, füllen Sie die Anzeigezeile mit Leerzeichen auf 19 Zeichen auf, dadurch erfolgt ein automatischer Umbruch auf die nächste Zeile. Die Anzeige der Nachricht während sich das Gerät in einer Eingabekette befindet ist erst ab der Firmware mit Majorversion >= 2 möglich.

Nur PZE-MasterIV
Zeilenumbrüche müssen mit dem Zeichen (Dec. 13) eingefügt werden. 
Beim PZE-MasterIV ist durch den proportionalen Zeichensatz die Anzahl der Zeichen pro Zeile vom Zeileninhalt abhängig und die Zeile wird bei Randüberschreitung abgeschnitten.  

 

Die gesendete Zeichenfolge unterliegt folgender Aufteilung:

Kopfzeile 3\rKopfzeile 4\rBoxenüberschrift\rBoxenzeile 1\rBoxenzeile 2 usw...

\r muß hierbei durch ein Zeilenumbruch (Dec. 13) ersetzt werden. Wenn Sie keine Kopfzeilen wünschen, dann müßen Sie für jede Kopfzeile ein Leerzeichen mit folgendem Zeilenumbruch einfügen, damit die Aufteilung nach obigem Schema erfolgen kann. Das anzeigen von mehr als fünf Boxzeilen wird in der Fimrwareversion 04.00.22 noch nicht unterstützt, auch darf in der Box die Gesamtanzahl der Zeichen 128 (inklusive Nullterminierung) nicht überschreiten.
Beispiel:
char *Buffer = "HALLO DIES IST EIN TEST !";

DFCComSendMessage(1, 254, 255, 0, 2, Buffer, 26);

 

2.1.8     DFCComSendInfotext

Wird unterstützt ab Firmwareversion:
02.02.00, 03.01.00, BDE.04.01.02, MDE.04.01.02
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCComSendInfotext(int iChannelNum, int iBusNum,
char *szMessage, int iLength);

Exportiert: _DFCComSendInfotext@16
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *szMessage Zeiger auf die darzustellende Zeichenkette.
int iLength Zeichenlänge der Meldung. Maximal 242.
Rückgabewert:
0 Fehler beim Senden.
1 Meldung erfolgreich gesendet.
Beschreibung:
Sendet einen Infotext an das Gerät mit der angegebenen Busnummer. Der Infotext wird im Speicher des Geräts gehalten und steht so zur ständigen Verfügbarkeit. 
Er kann über die linke Pfeiltaste aus dem Hauptmenü heraus erreicht werden. 

Im PZE - Modus ist durch die Fixierung der Eingabe auf die ersten Einträge im Hauptmenü (F1 / F2), das Erreichen des Infobildschirms versperrt. Im PZE - Betrieb ist das Infobild deswegen nicht allzu sinnvoll anzuwenden.

Das AEIII+ kann pro Zeile maximal 19 Zeichen darstellen, das zwanzigste ist für die Laufleiste reserviert. Bitte beachten Sie, daß Sonderzeichen sowie Umlaute durch den vorgegebenen Displayzeichensatz nicht richtig dargestellt werden können.
Wenn Sie einen Zeilenumbruch erreichen möchten, füllen Sie die Anzeigezeile mit Leerzeichen auf 19 Zeichen auf, dadurch erfolgt ein automatischer Umbruch auf die nächste Zeile.
Beispiel:
char *Buffer = "HALLO DIES IST EIN TEST !";

DFCComSendInfotext(1, 254, Buffer, 26);

 

2.1.9     DFCGetSeriennummer

Wird unterstützt ab Firmwareversion:
02.02.00, 03.01.00, 04.00.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetSeriennummer(int iChannelNum, int iBusNum,
int *piError, int *piSerialNum); 

Exportiert: _DFCGetSeriennummer@16
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
int *piSerialNum Zeiger auf Variable welche die Seriennummer erhält.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung: 
Liest die Seriennummer des angesprochenen Gerätes.

 

2.1.10.1     DFCLogOn

 Nicht weiter in Verwendung. 

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCLogOn(char *szFileName);

Exportiert: _DFCLogOn@4
Parameter: 
char* szFileName Zeichenkette mit Dateinamen der Log-Datei (inklusive Pfad).
Rückgabewert: 
0 Funktion nicht implementiert.
Beschreibung: 
Die Implementierung wurde entfernt!!! Bitte auf DFCSetLogOn umsetzen.

 

2.1.10.2     DFCSetLogOn

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCSetLogOn(int iChannelNum);

Exportiert: _DFCSetLogOn@4
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
Rückgabewert: 
keiner
Beschreibung: 
Log-Funktion wird eingeschaltet und Log-Datei wird geöffnet.
Alle aus dem Gerät gelesenen Daten werden binär abgespeichert. Vor den Datenbyte wird ein Byte mit der Anzahl der Datenbyte abgespeichert. Dieses Byte wird nicht mitgezählt.

Beispiel:
Ein Datensatz enthält 20 Byte. 
Das vorangestellte Byte hat den Wert 20.
Die Gesamtzahl der gespeicherten Byte für diesen Datensatz incl. Längenbyte ist 21.

Zuvor müssen Sie mit DFCSetLogFileName den Name der Datei bekannt geben.

 

2.1.11.1     DFCLogOff

 Nicht weiter in Verwendung. 

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCLogOff(void);

Exportiert: _DFCLogOff@0
Parameter: 
keine  
Rückgabewert: 
keiner  
Beschreibung: 
Implementierung wurde entfernt!!! Bitte auf DFCSetLogOff umstellen.

 

2.1.11.2     DFCSetLogOff

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCSetLogOff(int iChannelNum);

Exportiert: _DFCSetLogOff@4
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
Rückgabewert: 
keiner  
Beschreibung: 
Log - Funktion wird für angegebenen Kanal abgeschaltet.

 

2.1.12     DFCSetCallBack

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCSetCallBack(int iChannelNum, int (*CBFunction)());

Exportiert: _DFCSetCallBack@8
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int (*CBFunction)() Zeiger auf die aufzurufende Funktion.
RückgabewertBedeutung
0Die Befehlsausführung wird abgebrochen.
1Der Befehl wird weiter abgearbeitet.
Rückgabewert: 
Keiner  
Beschreibung: 
Unter Zuhilfenahme einer CallBack-Funktion besteht die Möglichkeit eine Fortschrittsanzeige zu realisieren. Die mit dieser Funktion an die DLL übergebene CallBack-Funktion, wird bei der Übertragung größerer Datenblöcke zyklisch aufgerufen. Über den zurückgegebenen Wert, kann eine z.B. die Übertragung einer Setupdatei oder Gerätedatei (Firmware) abgebrochen werden.
Der Aufruf dieser Funktion gibt jedoch keinen Aufschluss über die zu übertragende Datenmenge um mit Prozenten zu rechnen.

 

2.1.13     DFCSetLogFileName

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCSetLogFileName(int iChannelNum,
const unsigned char *szLogFileName);

Exportiert: _DFCSetLogFileName@8
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
const unsigned char *szLogFileName Datei die zum Loggen verwendet werden soll.
Rückgabewert: 
keiner  
Beschreibung: 
Setzt die Datei für die Loggfunktionen im jeweiligen Kanal.

 

2.1.14     DFCGetErrorText

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCGetErrorText(int iChannelNum, int iError,
int iLanguage, char *szText, int iLength);

Exportiert: _DFCGetErrorText@20
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iError Fehlercode der durch Parameter von den meisten anderen zurückgegeben wird.
int iLanguage noch nicht verwendet. Alles Deutsch
char *szText Zeiger auf die verwendbar Zeichenkette.
int iLength Länge des Reservierten Speichers auf die Zeichenkette.
Rückgabewert: 
keiner  
Beschreibung: 
Löst die von den verschiedenen Funktionen zurückgegebene Fehlernummer nach Tabelle 1.3.3 auf.

 

2.1.15     DFCSetGlobVar

Wird unterstützt ab Firmwareversion:
02.02.20, 03.01.00, 04.00.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSetGlobVar(int iChannelNum, int iBusNum,
unsigned char *pucVar, int iType, unsigned char *pucValue, int *piError);

Exportiert: _DFCSetGlobVar@24
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
unsigned char *pucVar Name oder Nummer der Variablen.
int iType
WertBedeutung
0pucVar zeigt auf Byte welches die Variablennummer darstellt. Der gültige Bereich liegt zwischen 1 - 8. Im AESetup auf der Seite für die Globalen Variablen entspricht dies der Anordnung von oben links nach unten links 1 - 4 und auf der rechten Seite entsprechend 5 - 8.
1pucVar zeigt auf terminierte Zeichenfolge die den Namen darstellt. Zwischen Groß- und Kleinschreibung wird unterschieden und er kann maximal 16 ASCII - Zeichen umfassen.
2pucVar zeigt auf terminierte Zeichenfolge die den Namen einer Systemvariable darstellt. z. B. "_MODEM_MC35i.PHONE". Siehe auch Kapitel Systemvariablen
unsigned char *pucValue Zeigt auf terminierte Zeichenfolge die den Wert darstellt. Bei der unterstützenden FW mit Majornummer 2, sind maximal 20 ASCII - Zeichen möglich. Bei der unterstützenden FW mit Majornummer 3, sind maximal 60 ASCII - Zeichen möglich.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Setzen des Wertes einer Globalen Variablen.

 

2.1.16     DFCGetGlobVar

Wird unterstützt ab Firmwareversion:
02.02.20, 03.01.00, 04.00.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetGlobVar(int iChannelNum, int iBusNum,
unsigned char *pucVar, int iType, unsigned char *pucValue,
int iValueLength, int *piError);

Exportiert: _DFCGetGlobVar@28
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
unsigned char *pucVar Name oder Nummer der Variablen.
int iType
WertBedeutung
0pucVar zeigt auf Byte welches die Variablennummer darstellt. Der gültige Bereich liegt zwischen 1 - 8. Im AESetup auf der Seite für die Globalen Variablen entspricht dies der Anordnung von oben links nach unten links 1 - 4 und auf der rechten Seite entsprechend 5 - 8.
1pucVar zeigt auf terminierte Zeichenfolge die den Namen darstellt. Zwischen Groß- und Kleinschreibung wird unterschieden und er kann maximal 16 ASCII - Zeichen umfassen.
2pucVar zeigt auf terminierte Zeichenfolge die den Namen einer Systemvariable darstellt. z. B. "_MODEM_MC35i.PHONE". Siehe auch Kapitel Systemvariablen
unsigned char *pucValue Wenn die Ausführung erfolgreich war, enthält der Buffer auf den dieser Zeiger zeigt die ermittelte Zeichenfolge für den Wert der Variablen. Bei der unterstützenden FW mit Majornummer 2, sind maximal 20 ASCII - Zeichen möglich. Bei der unterstützenden FW mit Majornummer 3, sind maximal 60 ASCII - Zeichen möglich.
int iValueLength Länge des reservierten Speicherbereiches auf den mit pucValue verwiesen wird. Bitte beachten Sie das die NULL - Terminierung in den Wert mit einfliest. d.h. Wenn Sie eine Längenangabe von 1 machen, bekommen Sie eine Leere Zeichenfolge zurückgeliefert, da kein ausreichender Bufferbereich für die Daten reserviert wurde.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Lesen des Wertes einer Globalen Variablen.

 

2.1.17     DFCCloseRelay

Wird unterstützt ab Firmwareversion:
02.02.20, 03.01.00, 04.00.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCCloseRelay(int iChannelNum, int iBusNum, int iNum,
int iTime, int *piError); 

Exportiert: _DFCCloseRelay@20
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int iNum Nummer des anzusprechenden Relais. Mit der Nummer "0" wird der interne Open - Collector - Ausgang geschaltet. Der Bereich "1 - 8" ist für die jeweils 4 (42V) und 4(230V) Relais des IO - Module.
int iTime Zeitangabe in Sekunden, für die der Ausgang, (das Relais), geschaltet werden soll. (1 .. 65535)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Schließen eines Ausgangs oder Relais für eine bestimmbare Zeit.

 

2.1.18     DFCGetRelayState

Wird unterstützt ab Firmwareversion:
02.02.20, 03.01.00, 04.00.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetRelayState(int iChannelNum, int iBusNum, int iNum,
int *piState, int *piTime, int *piError);

Exportiert: _DFCGetRelayState@24
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int iNum Nummer des anzusprechenden Relais. Mit der Nummer "0" wird der interne Open - Collector - Ausgang geschaltet. Der Bereich "1 - 8" ist für die jeweils 4 (42V) und 4(230V) Relais des IO - Module.
int *piState Erhält den aktuellen Relaiszustand. "1" steht für geschlossen.
int *piTime Erhält die verbleibende Zeitangabe in Sekunden, für die der Ausgang, (das Relais), noch geschaltet werden soll.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Lesen des aktuellen Zustandes eines Ausgangs oder Relais.

 

2.1.19     DFCOpenRelay

Wird unterstützt ab Firmwareversion:
02.02.20, 03.01.00, 04.00.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCOpenRelay(int iChannelNum, int iBusNum, int iNum,
int *piError);

Exportiert: _DFCOpenRelay@16
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int iNum Nummer des anzusprechenden Relais. Mit der Nummer "0" wird der interne Open - Collector - Ausgang geschaltet. Der Bereich "1 - 8" ist für die jeweils 4 (42V) und 4(230V) Relais des IO - Module.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Öffnen eines Ausgangs oder Relais.

 

2.1.20     DFCGetDevicePollRetry

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetDevicePollRetry(int iChannelNum);

Exportiert: _DFCGetDevicePollRetry@4
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
Rückgabewert: 
Anzahl Benötigte Anzahl Versuche für DFCCheckDevice - Vorgabe.
Beschreibung:
Bei der Funktion DFCCheckDevice wird ein Parameter übergeben, welcher die mögliche Anzahl der Versuche angibt. Diese Funktion liefert die Anzahl der benötigten Anfragen, bis die Funktion -erfolgreich- zurückmelden konnte, zurück.

 

2.1.21     DFCGetComPort

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
HANDLE __stdcall DFCGetComPort(int iChannelNum);

Exportiert: _DFCGetComPort@4
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
Rückgabewert: 
Handle Schnittstellenhandle (seriell) oder Socket der letzten Kanalinitialisierung. Der Wert ist (-1 = INVALID_HANDLE_VALUE / INVALID_SOCKET), wenn die Rückgabe scheitert. 
Der Typ HANDLE ist in C gleich einem Zeiger auf void.
Beschreibung:
Verwendung dieser Funktion ist nur bei einem direkten Zugriff auf die Schnittstelle nötig. Dieses kann bei einer Modeminitialisierung der Fall sein, wobei die Verbindungsstrecke zuerst aufgebaut werden muss und danach die anderen Funktionen der DLL wie bisher verwendet werden können. 
Bitte beachten Sie: 
Die DLL schließt durch DFCComClose keine zuvor geöffnete Modemverbindung durch AT-Befehle.
Der zurückgelieferte HANDLE ist nur für die zuvor geöffnete Schnittstelle und während dessen Bestehen als gültig zu betrachten.

 

2.1.22     DFCSetComPort

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSetComPort(int iChannelNum, HANDLE hComPort,
int iType, int iComValue, int iTimeOut);

Exportiert: _DFCSetComPort@20
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
HANDLE hComPort Schnittstellenhandle (seriell) oder Socket der gesetzt werden soll.
Der Typ HANDLE ist in C gleich einem Zeiger auf void.
int iType Der Wert gibt an, welche Schnittstellenart vorliegt:
WertBedeutung
0DFCComOpenSerial, DFComInit
1DFCComOpenSocket, DFCComOpen
2DFCComOpenIV für serielle Verbindung.
3DFCComOpenIV für TCP/IP Verbindung.
int iComValue Bei seriellen Verbindungen gibt dieser Parameter die Baudrate an (Standard: 38400bd) und bei TCP/IP die Portnummer (Standard: 8000).
int iTimeOut Dieser Parameter gibt den zu verwendenden Schnittstellentimeout in Millisekunden an. Bei serieller Verbindung ist Standardmäßig 150ms einzustellen, bei TCP/IP Standardmäßig 3000ms.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Die Verwendung dieser Funktion ist in äußerst wenigen Fällen nötig, z.B. zum Einstellen eines anderen Schnittstellentimeouts, während die Schnittstelle bereits geöffnet ist oder um der DLL einen zuvor anderweitig genutzten Handle zu übergeben. 

 

2.1.23     DFCWrite

 Achtung: 
Die Funktion sollte nur für Sonderfälle wie Modeminitialisierung verwendet werden! Durch unsachgemäßen Gebrauch, können Störungen in der Kommunikation auftreten.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCWrite(int iChannelNum, char *pBuf, int iLength,
int *piWriteLength, int *piError);

Exportiert: _DFCWrite@20
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
char *pBuf Zeiger auf die zu versendenden Zeichen.
int iLength Anzahl der zu versendenden Zeichen.
int *piWriteLength (Rückgabe) Anzahl der wirklich gesendeten Zeichen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Schreibt, je nach verwendeter Schnittstelle, die übergebenen Daten in den Kanal.

 

2.1.24     DFCRead

 Achtung: 
Die Funktion sollte nur für Sonderfälle wie Modeminitialisierung verwendet werden! Durch unsachgemäßen Gebrauch, können Störungen in der Kommunikation auftreten.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCRead(int iChannelNum, char *pBuf, int iLength,
int *piReadLength, int *piError);

Exportiert: _DFCRead@20
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
char *pBuf Zeiger auf Zeichenpuffer für die zu empfangenden Zeichen.
int iLength Anzahl der zu lesenden Zeichen. (größe Zeichenpuffer)
int *piReadLength (Rückgabe) Anzahl der wirklich gelesenen Zeichen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Liest, je nach verwendeter Schnittstelle, die anliegenden Daten aus dem Kanal.
Hinweis:
 

Es ist wichtig, nicht nur den Rückgabeparameter auf seinen Wert zu überprüfen. Ob ein Fehler vorlag ist nur in Verbindung mit dem zurückgelieferten Error-Code möglich. Handelt es sich um eine serielle Verbindung und es waren keine Daten zum lesen verfügbar wird von der Funktion ein Returnwert von 1 zurückgegeben. Bei einer TCP/IP Verbindung wird allerdings ein Returnwert von 0 zurückgeliefert, wenn es keine Daten zu lesen gab. Es empfiehlt sich für eine Fehlerbehandlung dieser Funktion grundsätzlich den Errorcode zu verwenden (ist dieser ≠0 lag ein Fehler vor). 

Verbindung Returnwert ReadLength Error Status  Beschreibung
seriell =1 =0 =0 Ok es wurde erfolgreich gelesen, die Anzahl der gelesenen Zeichen war jedoch 0
seriell =1 >0 =0 OK es wurde erfolgreich gelesen, die Anzahl der gelesenen Zeichen war >=1
TCP/IP =0 =0 =0 Ok es wurde erfolgreich gelesen, die Anzahl der gelesenen Zeichen war jedoch 0
TCP/IP =1 >0 =0 Ok es wurde erfolgreich gelesen, die Anzahl der gelesenen Zeichen war >=1
seriell
TCP/IP		 =0 >=0 ≠0 Error es wurde nicht erfolgreich gelesen, in ReadLength steht die Anzahl und in Buf die Zeichen die bis zum Auftreten des Fehlers gelesen  werden konnten.

!! Wichtig: Die entsprechenden Funktionen der DLL für den Timeboy, haben genau das entgegengesetzte Verhalten wenn es keine Daten zu lesen gab!
 

 

 

2.1.25     DFCUpload

 Achtung: 
Mehr Informationen zum Übertragen von Gerätedateien (DFCUpload).
Wird unterstützt ab Firmwareversion:
04.00.08
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCUpload(int iChannelNum, int iBusNum, char *szFileName,
int *piError);

Exportiert: _DFCUpload@16
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *szFileName Dateiname der Gerätedatei oder Textdatendatei, wenn nötig mit Pfadangabe.
  1. Firmware mit Zusatzdaten, Endung: *.hex, mit Archiv Endung: *.dfz
    Unter Win32 kann ein Gerätedateiarchiv (Endung: *.dfz/*.zip) angegeben werden. Unter Linux kann ein Verzeichnis mit den enthaltenen Gerätedateien (Endung: *.hex) angegeben werden.
  2. Textdaten der Firmware, Endung: *.dfl
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Übertragen der notwendigen Gerätedaten, die aus Zeichensatz-, Grafik-, Text-, "Firmwaredaten" usw.. bestehen und zusammen in einer Datei mit der Endung (*.hex) geliefert werden.
Die Gerätedateien können auch (unter Win32) in einem Zip-Archiv vorliegen. Die Routine wählt in diesem Fall die für die jeweils vorliegende Hardware benötigte Gerätedatei aus dem Zip-Archiv aus.
Achtung: Unter Linux ist das Zip-Archiv zu entpacken und das Verzeichnis anzugeben.
Mehr Informationen zum Übertragen von Gerätedateien (DFCUpload).

Übertragen der Textdaten zur Firmware. Die Daten liegen in einer Datei mit der Endung *.dfl ([D]ata[f]ox [L]anguage) vor. Die Datei kann mit hilfe des DatafoxStudioIV erstellt werden.

 

2.1.26     DFCGetVersionFirmware

Wird unterstützt ab Firmwareversion:
04.00.19, 03.01.21
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetVersionFirmware(int iChannelNum, int iBusNum,
char *szVersion, int *piError);

Exportiert: _DFCGetVersionFirmware@16
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *szVersion Zeiger auf Zeichenkette für die Versionsnummer. Mindestens 32 Zeichen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Lesen der Gerätesoftwareversion im Textformat. z. B.: 04.00.19

 

2.1.27     DFCGetVersionFirmwareFromFile

Wird unterstützt ab Firmwareversion:
04.00.23
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetVersionFirmwareFromFile(int iChannelNum,
char *szFileName, char *szVersion, int *piError);

Exportiert: _DFCGetVersionFirmwareFromFile@16
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
char *szFileName Dateiname der Gerätedatei, wenn nötig mit Pfadangabe.
("Firmware" mit Zusatzdaten, Endung: *.hex)
char *szVersion Zeiger auf Zeichenkette für die Versionsnummer. Mindestens 32 Zeichen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3. Dieser Wert besagt mit der Nummer 1, dass die Prüfsumme des Dateikopfes oder der enthaltenen Firmwaredaten unstimmig ist.
Rückgabewert: 
0 Fehler bei Durchführung.
>7 Anzahl der kopierten Zeichen in den Puffer "szVersion".
Beschreibung:
Lesen der Gerätesoftwareversion im Textformat. z. B.: 04.00.23 direkt aus der Firmwaredatei.

 

2.1.28     DFCGetInfo

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetInfo(int channelID, int deviceID, char *name, char *params,
char *info, int *len, int *piError);

Exportiert: _DFCGetInfo@28
Parameter: 
int channeID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *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:
BereichBeschreibung
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:
BereichKomponendeBeschreibung
ACCESSMODULEZutrittsmodul / -leser
FINGERPRINTMODULEFingerprintmodul firmwareversion
USBHOSTMODULEUSB-Host firmwareversion (z.B. "3.62-000VDAP").
char *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:
NameParameterBeschreibung
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".
FINGERPRINT.MODULE 1Leer
USBHOST.MODULE 1Leer
char *info Zeiger auf Zeichenkette 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.

WertPositionBeschreibung
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.
.........
...nZur Zeit noch nicht definiert, jedoch denkbar.
int *len Als Eingabe die Länge des reservierten Buffers auf den der Zeiger *info verweist, als Ausgabe die Länge der übergebenen Zeichenkette.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3. 
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
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.)

 

2.1.29     DFCOpenComServerMode

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCOpenComServerMode(int channelID, int deviceID, char *comm, int baudRate,
int byteSize, int parity, int stopBits, int flags,int timeoutToClose, int *error);

Exportiert: _DFCOpenComServerMode@40
Parameter: 
int channeID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceD Gibt die Busnummer an. Muss in der derzeitigen Implementierung immer 254 sein, da der “Transparentmodus” in einem RS485 - Netzwerk nicht vorgesehen ist.
char *comm Zeiger auf Zeichenkette für den zu öffnenden virtuellen COM-Port.
ZeichenketteBedeutung
COM5
GerätSchnittstelle
PZE-MasterIVNicht vorhanden.
ZK-MasterIVNicht vorhanden.
BDE-MasterIVCOM3 (siehe Handbuch)
Mobil-MasterIVCOM2 (siehe Handbuch)
MDE-BoxIVCOM2 (siehe Handbuch)
AE-MasterIVCOM2 (siehe Handbuch)
COM6
GerätSchnittstelle
PZE-MasterIVCOM1 (siehe Handbuch)
ZK-MasterIVCOM1 (siehe Handbuch)
BDE-MasterIVCOM2 (siehe Handbuch)
Mobil-MasterIVCOM1 (siehe Handbuch)
MDE-BoxIVCOM1 (siehe Handbuch)
AE-MasterIVCOM1 (siehe Handbuch)
int baudRate Die zu verwendende Baud Rate der Schnittstelle.
WertBedeutung
96009600bd
1920019200bd
3840038400bd
int byteSize Die zu verwendende Anzahl "Bits per Byte" der Schnittstelle.
WertBedeutung
44 Bit
55 Bit
66 Bit
77 Bit
88 Bit (Standard)
int parity
WertBedeutung
0Paritätsprüfung nicht durchführen. (Standard)
1Paritätsprüfung durchführen.
int stopBits Die zu verwendende Anzahl Stoppbits
WertBedeutung
01 Stoppbit (Standard)
11,5 Stoppbits
22 Stoppbits
int flags Zusätzliche Informationen um den Com-Server-Mode zu beeinflussen:
Bit Nr.Bedeutung
0Bei gesetztem Bit, wird nach einem Pufferüberlauf, die Datenweiterleitung in beide Richtungen abschalten.
...Unbenutzt. Bitte immer 0.
int timeoutToClose Zeitspanne nachdem der COM-Port geschlossen wird, wenn kein Datentransfer statt findet.
WertBedeutung
0Es wird nicht automatisch geschlossen.
1..255Es wird, wenn für die Angegebene Zeit (in Sekunden) kein Datenfluss vorhanden war, automatisch geschlossen.
int *error Error erhält eine Fehlernummer nach Tabelle 1.3.3. 
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Aktiviert bei dem angesprochenen Gerät einen “Transparentmodus” zwischen dem aktuell geöffneten Kanal und einem COM-Port des Gerätes. Nachdem Sie einen COM-Port des Gerätes mit dem Kanal verbunden haben ist es z. B. möglich eine Datei direkt an eine angeschlossene CNC-Maschine zu senden. Es werden sozusagen alle darauffolgenden Daten 1:1 zwischen dem Geräte-COM-Port und dem geöffneten Kanal durchgereicht, lediglich der Befehl zum Aufheben des “Transparentmodus” (DFCCloseComServerMode) wird abgefangen.
Um Daten direkt in den Kanal zu schreiben steht Ihnen die Funktion DFCWrite zur Verfügung, um ggf. Antwortdaten aus dem Kanal zu lesen, steht Ihnen die Funktion DFCRead zur Verfügung. Sie könnten z. B. auch über einen Aufruf der Funktion DFCGetComPort, den DLL-eigenen Schnittstellenhandle ermitteln und somit über eigene Schreib-/Leseroutinen arbeiten, ggf. die Timeboy-DLL anbinden.
Bitte beachten Sie, dass der Geräteinterne Puffer für jede Kommunikationsrichtung 512Byte umfasst und bei Verwendung ungleicher Übertragungsraten ein Überlauf stattfinden kann. Wenn Sie z.B. über die TCP/IP Schnittstelle (57600bd) Daten an einen COM-Port mit eingestellten 9600bd übertragen muss der Gesamtdatenstrom immer nach 512 Byte für ca. 400ms unterbrochen werden.
Einen eventuell eingetretenen Überlauf bekommen Sie von der Funktion DFCCloseComServerMode gemeldet.

 

2.1.30     DFCCloseComServerMode

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCCloseComServerMode(int channelID, int deviceID, int *error);

Exportiert: _DFCCloseComServerMode@12
Parameter: 
int channeID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceD Gibt die Busnummer an. Muss in der derzeitigen Implementierung immer 254 sein, da der “Transparentmodus” in einem RS485 - Netzwerk nicht vorgesehen ist.
int *error Error erhält eine Fehlernummer nach Tabelle 1.3.3. 
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Deaktiviert bei dem angesprochenen Gerät einen evntl. zuvor eingestellten “Transparentmodus”. Siehe Funktion DFCOpenComServerMode zum öffnen der Verbindung.
Wenn wärend der Datenübertragung ein Geräteinterner Speicherüberlauf stattfindet, gibt die Funktion den Fehlercode 40 zurück.

 

2.1.31     DFCIsChannelOpen

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCIsChannelOpen(int channelID);

Exportiert: _DFCIsChannelOpen@4
Parameter: 
int channeID Der auszuwerdente Kanal. Wertebereich: (1 - 250)
Rückgabewert: 
0 Kanal ist nicht geöffnet.
1 Kanal ist offen.
Beschreibung:
Prüft ob der Kanal geöffnet ist. Die Funktion stellt dabei nicht Sicher das ein Verbundenes Gerät auch angesprochen werden kann.

 

2.1.32     DFCUploadModule

Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCUploadModule(int iChannelNum, int iBusNum, int type, char *szFileName,
int *piError);

Exportiert: _DFCUploadModule@20
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int type Gibt den zu aktualisierenden Modultypen an.
Derzeit: 0 -> Biokey3000.
char *szFileName Dateiname der Updatedatei, wenn nötig mit Pfadangabe.
Derzeit muss bei type = 0 die Dateiendung *.upd sein.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Übertragen der notwendigen Updatedaten, an das über type angegebene Module.

 

2.1.33     DFCGetOptionFirmware

Wird unterstützt ab Firmwareversion:
04.01.06
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetOptionFirmware(int channelID, int deviceID, int *mask, int *options,
int *error);

Exportiert: _DFCGetOptionFirmware@20
Parameter: 
int channeID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceD Gibt die Busnummer an. Muss in der derzeitigen Implementierung immer 254 sein, da der “Transparentmodus” in einem RS485 - Netzwerk nicht vorgesehen ist.
int *mask Zeiger auf die Maskenvariable, welche nach dem auslesen angibt welche Werte der Optionen gültig sind.
WertBedeutung
0x00000001Externer Lesertyp
0x00000002IO-Modul Anbindung
0x00000004Timeboy Anbindung
0x00000008Com-Server Funktionalität.
0x00000010Transpondermenü zum schreiben der Ausweise benötigt.
0x00000020HTTP-Protokoll Unterstützung.
0x00000040Funktionalität für Update des Biokey Moduls benötigt.
0x00000080Unterstützung der Signalverarbeitung (digitale Eingänge vorhanden).
int *options Zeiger auf die Optionsvariable, welche nach dem auslesen angibt welche Werte der Optionen gesetzt sind.
WertBedeutung
Externer Lesertyp0 = Datafox-TMR33, 1 = PHG (VOXIO, Relino,...)
IO-Modul Anbindung0 = Nein, 1 = Ja
Timeboy Anbindung0 = Nein, 1 = Ja
Com-Server Funktionalität.0 = Nein, 1 = Ja
Transpondermenü zum schreiben der Ausweise benötigt.0 = Nein, 1 = Ja
HTTP-Protokoll Unterstützung.0 = Nein, 1 = Ja
Funktionalität für Update des Biokey Moduls benötigt.0 = Nein, 1 = Ja
Unterstützung der Signalverarbeitung (digitale Eingänge vorhanden).0 = Nein, 1 = Ja
int *error Error erhält eine Fehlernummer nach Tabelle 1.3.3. 
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Auslesen der aktuell gesetzten Optionen.

 

2.1.34     DFCSetOptionFirmware

Wird unterstützt ab Firmwareversion:
04.01.06
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSetOptionFirmware(int channelID, int deviceID, int mask, int options,
int *error);

Exportiert: _DFCSetOptionFirmware@20
Parameter: 
int channeID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceD Gibt die Busnummer an. Muss in der derzeitigen Implementierung immer 254 sein, da der “Transparentmodus” in einem RS485 - Netzwerk nicht vorgesehen ist.
int mask Maskenvariable, welche angibt, welche Werte der Optionsvariable gültig sind.
WertBedeutung
0x00000001Externer Lesertyp
0x00000002IO-Modul Anbindung
0x00000004Timeboy Anbindung
0x00000008Com-Server Funktionalität.
0x00000010Transpondermenü zum schreiben der Ausweise benötigt.
0x00000020HTTP-Protokoll Unterstützung.
0x00000040Funktionalität für Update des Biokey Moduls benötigt.
0x00000080Unterstützung der Signalverarbeitung (digitale Eingänge vorhanden).
int options Optionsvariable, welche angibt wie die Optionen gesetzt werden.
WertBedeutung
Externer Lesertyp0 = Datafox-TMR33, 1 = PHG (VOXIO, Relino,...)
IO-Modul Anbindung0 = Nein, 1 = Ja
Timeboy Anbindung0 = Nein, 1 = Ja
Com-Server Funktionalität.0 = Nein, 1 = Ja
Transpondermenü zum schreiben der Ausweise benötigt.0 = Nein, 1 = Ja
HTTP-Protokoll Unterstützung.0 = Nein, 1 = Ja
Funktionalität für Update des Biokey Moduls benötigt.0 = Nein, 1 = Ja
Unterstützung der Signalverarbeitung (digitale Eingänge vorhanden).0 = Nein, 1 = Ja
int *error Error erhält eine Fehlernummer nach Tabelle 1.3.3. 
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Setzen der aktuell gesetzten Optionen.

 

2.1.35     DFCReset

Wird unterstützt ab Firmwareversion:
04.01.07
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCReset(int channelID, int deviceID, int mode, int *error);

Exportiert: _DFCReset@16
Parameter: 
int channeID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceD Gibt die Busnummer an. Muss in der derzeitigen Implementierung immer 254 sein, da der “Transparentmodus” in einem RS485 - Netzwerk nicht vorgesehen ist.
int mode Modusvariable, welche angibt, was zurückgesetzt durchgeführt wird.
WertBedeutung
1Warmstart des Gerätes.
...Unbenutzt
int *error Error erhält eine Fehlernummer nach Tabelle 1.3.3. 
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Reset je nach gewähltem Modus durchführen.

 

2.1.36     DFCSetFontType

Wird unterstützt ab Firmwareversion:
04.01.07
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSetFontType(int channelID, int deviceID, int iType, int *error);

Exportiert: _DFCSetFontType@16
Parameter: 
int channeID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceD Gibt die Busnummer an. Muss in der derzeitigen Implementierung immer 254 sein, da der “Transparentmodus” in einem RS485 - Netzwerk nicht vorgesehen ist.
int iType Typ der zu verwendenden Schriftart.
WertBedeutung
0Standardschrift
116 Pixel (7Anzeigezeilen)
216 Pixel,feste breite(7Zeilen)
319 Pixel(6Anzeigezeilen)
419 Pixel,feste breite(6Zeilen)
521 Pixel(5Anzeigezeilen)
621 Pixel,feste breite(5Zeilen)
...Unbenutzt
int *error Error erhält eine Fehlernummer nach Tabelle 1.3.3. 
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
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.

 

2.1.37     DFCSetPassword

Wird unterstützt ab Firmwareversion:
04.01.07
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSetPassword(int channelID,
char *password, int *piError);

Exportiert: _DFCSetPassword@12
Parameter: 
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
char *password Zeiger auf das zu verwendende Kommunikationspasswort. Maximal 16 Zeichen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Übernahme.
1 Erfolgreich übernommen.
Beschreibung:
Setzen des zu verwendenden Kommunikationspasswortes für diesen Kanal. 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 DLL mitgeteilt werden.

 

2.1.38     DFCGetPasswordKey

Wird unterstützt ab Firmwareversion:
04.01.07
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetPasswordKey(int channelID, int deviceID,
char *key, int *len, int *piError);

Exportiert: _DFCGetPasswordKey@20
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *key Key erhält den gelesenen Passwortschlüssel. Dieser ist 16 Zeichen lang.
int *len Als Eingabe die Länge des Buffers auf den der Zeiger *key verweist, als Ausgabe die übergebene Anzahl Daten. Die Länge muss mindestens 17 Zeichen sein.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:

Für den Fall, dass das Kommunikationspasswort verloren gegangen ist, kann über diese Funktion ein Passwortschlüssel vom Gerät angefordert werden.
Dieser kann über die Fa. Datafox zu einem Ersatzpasswort gewandelt werden. Hierdurch bleibt Ihr vergebenes Passwort unbekannt.<
Mit dem Ersatzpasswort könnten Sie Ihr Setup aus dem Gerät lesen um das verlegte Passwort zu erhalten. Wenn Sie wieder mit Ihrem Passwort mit dem Gerät kommunizieren wird durch die Firmware ein neuer Passwortschlüssel (Ersatzpasswort) generiert. Das erhaltene Ersatzpasswort ist danach ungültig.

2.1.39     DFCPressVirtualKey

Wird unterstützt ab Firmwareversion:
04.01.07
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCPressVirtualKey(int channelID, int deviceID, int virtualKey,
 int flags, int *piError);

Exportiert: _DFCPressVirtualKey@20
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int virtualKey Gibt 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
...Unbenutzt
int flags Gibt zuzätzliche Bedeutungen zum Tastendruck an:
BitnummerWertBedeutung
10, 1Wenn 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.
......Unbenutzt
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Ü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.

 

2.1.40     DFCGetFlashStatus

Wird unterstützt ab Firmwareversion:
04.01.07
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetFlashStatus(int channelID, int deviceID, int *status,
 int *piError);

Exportiert: _DFCGetFlashStatus@16
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int *status Zeiger auf die Variable, welche den Status erhält.
Bei dem Wert handelt es sich um Bit-Flags mit folgender Bedeutung:
BitWertBedeutung
11Service: Bei gesetztem Bit ist die vom Hersteller zugesicherte Beschreibbarkeit des Bausteins erreicht. Ein Bausteinaustausch sollte vorgenommen werden.
22Warnung: Es liegt ein CRC Fehler im Datensatz- oder Listenbereich vor. Ein Neuübertragung des verwendeten Setups und der zugehörigen Listen behebt die Warnung.
34Fehler: Der Speicherbaustein ist defekt und muss für den weiteren Gerätebetrieb ausgetauscht werden.
......Unbenutzt
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Über diese Funktion können Sie den aktuellen Status des Hauptspeicherbausteins abrufen. Das Speichermanagement prüft automatisch die Datenkonsistenz und Schreibzyklen auf alle Speicherzellen, tritt hierbei ein Fehler oder Warnung auf, kann dieses über diese Funktion abgerufen werden.

 

2.2     Funktionen für Setup

Konfigurationsdaten mit dem Gerät abgleichen.

2.2.1     DFCSetupLaden

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSetupLaden(int iChannelNum, int iBusNum,
char *szFileName, int *piError);

Exportiert: _DFCSetupLaden@16
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *szFileName Dateiname der Setup-Datei (wenn notwendig mit Pfad).
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung: 
Setup-Daten aus Datei (*.aes) lesen und in Gerät übertragen.

 

2.2.2     DFCDownload

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCDownload(int iChannelNum, int iBusNum,
char *szFileName, int *piError);

Exportiert: _DFCDownload@16
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *szFileName Dateiname der Setup-Datei (wenn notwendig mit Pfad).
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung: 
Setup-Daten aus Gerät lesen und in Datei (*.aes) übertragen.

 

2.2.3     DFCModifyStudioFile

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCModifyStudioFile(char *sourceFile, char *destFile,
char *changeData, int flags, int *piError);

Exportiert: _DFCModifyStudioFile@20
Parameter: 
char *sourceFile Quelldatei: Dateiname der Setup-Datei mit zu verändernden Daten. (wenn notwendig mit Pfad).
char *destFile Zieldatei: Dateiname der Setup-Datei mit veränderten Daten. (wenn notwendig mit Pfad).
char *changeData Entweder ein Textpuffer mit xml-Daten (Beginnt mit <?xml) oder Dateiname der XML-Datei mit den enspechenden Daten.
int flags Reserviert.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung: 
Daten einer Setupdatei (*.aes) modifizieren und abspeichern.
 Beispiel der XML-Daten:
<?xml version="1.0" ?>
<modify>

	<password>
		<system>
			<value>1234</value>
		</system>
		<user>
			<value>2345</value>
		</user>
		<menu_item>
			<name>MEID_003</name>
			<value>4711</value>
		</menu_item>
	</password>

	<fingerprint>
		<security_level>20</security_level>
		<image_quality>70</image_quality>
		<minutiae_count>20</minutiae_count>
	</fingerprint>

	<replace>
		<name>
			<search>MID_001</search>
			<replacement>PZE Setup</replacement>
		</name>
		<name>
			<search>MEID_001</search>
			<replacement>Kommt:</replacement>
		</name>
		<name>
			<search>MEID_002</search>
			<replacement>Geht:</replacement>
		</name>
		<name>
			<search>MEID_003</search>
			<replacement>Abwesend</replacement>
		</name>
	</replace>

</modify>

 

2.3     Funktionen für Listen, sowie Zutrittslisten (Version 2)

Zugriff auf die Listen im Gerät.

2.3.1     DFCOpenTable

Wird unterstützt ab Firmwareversion:
PZE-MasterIV, ZK-MasterIV, MDE-MasterIV: 04.01.01.30
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCOpenTable(int channelID, int deviceID, char *name, int options,
int *handle, char *reserved, int *piError); 

Exportiert: _DFCOpenTable@28
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *name Der Name der zu öffnenden Tabelle.
Die Gerätetabellen sind in verschiedene Bereiche eingeteilt, welche Sie über ein Namenspräfix ansprechen.
LIST. -> für Listenbeschreibungen aus dem Setup. (z. B. LIST.Personalstamm)
ACCESS. -> für Listen der Zutrittskontrolle Version 2
int options Zur Zeit nicht verwendet. Bitte immer 0 übergeben.
int *handle Handle erhält eine eindeutige Nummer, die bei allen weiteren Funktionsaufrufen verwendet werden muss.
char *reserved Reserviert. Bitte immer einen Leerstring übergeben.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:

Öffnet eine Liste und gibt einen Handle darauf zurück. Alle weiteren Listenfunktionen unter diesem Kapitel arbeiten mit dem hier zurückgelieferten Handle.
Die Liste muß um sie öffnen zu können, zuvor mit der Funktion DFCLoadListen in das Gerät übertragen worden sein.

Um die Liste "Personalstamm" aus dem Setup zu öffnen müssen Sie den Namen "LIST.Personalstamm" verwenden, um die Liste "Identification" aus der Zutrittskontrolle zu öffnen, müssen Sie den Namen "ACCESS.Identification" verwenden.

 

2.3.2     DFCCloseTable

Wird unterstützt ab Firmwareversion:
PZE-MasterIV, ZK-MasterIV, MDE-MasterIV: 04.01.01.30
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCCloseTable(int channelID, int deviceID, int handle, int *piError); 

Exportiert: _DFCCloseTable@16
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int handle Der Listenhandle. Handle von vorherigem Aufruf von DFCOpenTable.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:

Schließen der zuvor mit DFCOpenTable geöffneten Liste.

 

2.3.3     DFCSetFilter

Wird unterstützt ab Firmwareversion:
PZE-MasterIV, ZK-MasterIV, MDE-MasterIV: 04.01.01.30
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSetFilter(int channelID, int deviceID, int handle,
char *filter, int *piError); 

Exportiert: _DFCSetFilter@20
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int handle Der Listenhandle. Handle von vorherigem Aufruf von DFCOpenTable.
char *filter Filterzeichenfolge nach folgendem Schema:
Spaltenname = 'Spaltenwert'
Der Spaltenwert kann in einzel- oder Doppelten Anführungszeichen stehen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:

Setzt einen Filter auf die angegebene Liste. Nach Aufruf dieser Funktion muss mit DFCSkip der Datensatzzeiger auf einen gültigen Datensatz verschoben werden.

 

2.3.4     DFCGetFilter

Wird unterstützt ab Firmwareversion:
PZE-MasterIV, ZK-MasterIV, MDE-MasterIV: 04.01.01.30
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetFilter(int channelID, int deviceID, int handle,
char *filter, int *len, int *piError); 

Exportiert: _DFCGetFilter@24
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int handle Der Listenhandle. Handle von vorherigem Aufruf von DFCOpenTable.
char *filter Filter erhält die ermittelte Zeichenfolge des Filterkriteriums.
Auf nach folgendem Schema: Spaltenname = 'Spaltenwert'
int *len Als Eingabe die Länge des reservierten Buffers auf den der Zeiger *filter verweist, als Ausgabe die Länge der übergebenen Zeichenkette.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:

Ermittelt das aktuell gesetzte Filterkriterium auf der Liste.

 

2.3.5     DFCClearFilter

Wird unterstützt ab Firmwareversion:
PZE-MasterIV, ZK-MasterIV, MDE-MasterIV: 04.01.01.30
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCClearFilter(int channelID, int deviceID, int handle, int *piError);

Exportiert: _DFCClearFilter@16
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int handle Der Listenhandle. Handle von vorherigem Aufruf von DFCOpenTable.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:

Entfernt einen gesetzten Filter von der Liste. Nach Aufruf dieser Funktion muss mit DFCSkip der Datensatzzeiger auf einen gültigen Datensatz verschoben werden.

 

2.3.6     DFCSkip

Wird unterstützt ab Firmwareversion:
PZE-MasterIV, ZK-MasterIV, MDE-MasterIV: 04.01.01.30
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSkip(int channelID, int deviceID, int handle,
int offset, int origin, int *piError);

Exportiert: _DFCSkip@24
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int handle Der Listenhandle. Handle von vorherigem Aufruf von DFCOpenTable.
int offset Anzahl zu übergehenden Datensätze. Der Wert kann auch Negativ sein.
int origin Worauf sich Offset beziehen soll:
WertBedeutung
0vom Beginn der Liste.
1von aktueller Position in Liste.
2vom Ende der Liste.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:

Versetzen des Datensatzzeigers einer Liste.

 

2.3.7     DFCSetField

 Achtung: 
Bei Verwendung von sortierten Listen, darf die Sortierspalte (Schlüsselfel) nicht verändert werden, da keine automatische Umsortierung erfolgt.
Wird unterstützt ab Firmwareversion:
PZE-MasterIV, ZK-MasterIV, MDE-MasterIV: 04.01.01.30
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSetField(int channelID, int deviceID,
int handle, char *name, char *value, int *piError); 

Exportiert: _DFCSetField@24
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int handle Der Listenhandle. Handle von vorherigem Aufruf von DFCOpenTable.
char *name Feldname.
char *value Wert der gesetzt werden soll.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:

Setzen eines Feldwerts.

 

2.3.8     DFCGetField

Wird unterstützt ab Firmwareversion:
PZE-MasterIV, ZK-MasterIV, MDE-MasterIV: 04.01.01.30
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetField(int channelID, int deviceID, int handle,
char *name, char *value, int *len, int *piError);

Exportiert: _DFCGetField@28
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int handle Der Listenhandle. Handle von vorherigem Aufruf von DFCOpenTable.
char *name Feldname.
char *value Value erhält die gelesenen Daten Feldes.
int *len Als Eingabe die Länge des Buffers auf den der Zeiger *value verweist, als Ausgabe die übergebene Anzahl Daten.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:

Lesen eines Feldwerts.

 

2.4     Funktionen für Daten

Sammeln der anfallenden Daten aus den Geräten und Interpretieren der gelieferten Informationen durch Abgleich mit Gerätekonfiguration.

2.4.1     DFCComClearData

 Achtung: 
Es ist nicht notwendig diese Funktion zu benutzen. Es ist davon sogar abzuraten, da aktuell eingegebene Daten ungeachtet gelöscht werden könnten.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCComClearData(int iChannelNum, int iBusNum);

Exportiert: _DFCComClearData@8
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
Rückgabewert:
0 Bei der Befehlsausführung ist ein Fehler aufgetreten.
1 Funktion wurde erfolgreich ausgeführt.
Beschreibung:

Löscht alle Daten im Gerät. Rücksetzten der Schreib und Lesezeiger im Gerät auf Speicheranfang.

 

2.4.2     DFCComCollectData

Ruft intern die Funktion DFCReadRecord auf.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCComCollectData(int iChannelNum, int iBusNum,
int *piError);

Exportiert: _DFCComCollectData@12
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
-1 Fehler bei Durchführung.
0 Keine Daten vorhanden
1 Offline Daten vorhanden
2 Online Daten vorhanden
Beschreibung:
Liest alle vorhandenen Daten aus dem Gerät aus und speichert sie im internen DLL-Speicher. Ab der Firmware mit Majorversion >= 2 wird hier nur ein Datensatz aus dem Gerät gelesen und die Busnummer für die weiteren Datensatzanfragen mit DFCComGetDatensatz festgelegt.

Die Datensätze werden zwischen Online und Offline unterschieden.
Online - Daten sind Daten die gerade eingegeben wurden. Ihr Zeitbereich liegt im definierten Server - Timeout, in diesem wurden sie von der DLL ausgelesen. Online - Daten können geprüft werden und der Benutzer kann mittels Mitteilung zu einer Neueingabe aufgefordert werden (siehe DFCComSendMessage). Offline-Daten wurden nach dem Server - Timeout aufgenommen.

 

2.4.3     DFCComGetDatensatz

Ruft intern die Funktionen DFCQuitRecord, DFCReadRecord auf.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCComGetDatensatz(int iChannelNum, unsigned char *pucBuf,
int *piLength, int *piError); 

Exportiert: _DFCComGetDatensatz@16
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
unsigned char *pucBuf Speicher, in dem die Daten abgelegt werden sollen.
 int *piLength Speicher in dem die Länge der gerade empfangen Daten gespeichert werden soll.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
-1 Fehler bei Durchführung.
0 Keine Daten vorhanden.
1 Weitere Daten vorhanden.
2 Letzter Datensatz.
Beschreibung:
Gibt genau einen Datensatz an die aufrufende Anwendung zurück.
Ist unter mehreren Datensätzen ein Online-Datensatz vorhanden, so wird dieser immer als letzter Datensatz aus der DLL in die Anwendung übertragen (er ist ja auch derjenige, der zuletzt eingegeben wurde). Die im Datensatz enthaltene Datenstruktur ist in Kapitel 3 beschrieben. 
Ab der Firmwareversion mit Majorversion >= 2 wird hier der zuletzt gelesene Datensatz übergeben, dann quittiert und der nächste aus dem Gerät gelesen (wenn vorhanden). Auf diese art werden die Datensätze satzweiße aus dem Gerät geladen. Wenn mit dem vorherigen Aufruf der Funktion DFCComCollectData ein Online - Datensatz gemeldet wurde, wird dieser als erster geliefert.

 

2.4.4     DFCLoadDatensatzbeschreibung

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCLoadDatensatzbeschreibung(int iChannelNum, int iBusNum,
int *piError);

Exportiert: _DFCLoadDatensatzbeschreibung@12
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Datensatzbeschreibungen aus dem Gerät lesen. Die Datensatzbeschreibungen werden in der DLL in einen Buffer abgelegt und können mit den Funktionen "DFCDatB..." ausgewertet werden.

 

2.4.5     DFCDatBCnt

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCDatBCnt(int iChannelNum); 

Exportiert: _DFCDatBCnt@4
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
Rückgabewert:
Anzahl Anzahl gefundener Datensatzbeschreibungen im Gerät.
Beschreibung:
Anzahl der ausgelesenen Datensatzbeschreibungen (nur gültig wenn vorher die Funktion "DFCLoadDatensatzbeschreibung" aufgerufen wurde).

 

2.4.6     DFCDatBDatensatz

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCDatBDatensatz(int iChannelNum,
int iDataNum, unsigned char *szName, int *piFieldCount);

Exportiert: _DFCDatBDatensatz@16
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iDataNum Nummer der Datensatzbeschreibung aus Setup.
(wird ab 0 gezählt)
unsigned char *szName Name der Datensatzbeschreibung.
(Speicher für Name muss min. 17 Byte haben) 
int *piFieldCount Anzahl Felder der Datensatzbeschreibung.
Rückgabewert:
0 Datensatzbeschreibung im Gerät nicht vorhanden.
1 Daten wurden übergeben.
Beschreibung:
Daten einer Datensatzbeschreibung abrufen (nur gültig wenn vorher die Funktion "DFCLoadDatensatzbeschreibung" aufgerufen wurde). Im Gerät können Datensätze mit unterschiedlichem Format gespeichert werden. Im Setup-Programm werden die Datensätze unter dem Punkt "Datensatzbeschreibungen" festgelegt. Die erste Datensatzbeschreibung im Setup-Baum hat die Nummer 0, die zweite die Nummer 1 ...

 

2.4.7     DFCDatBFeld

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCDatBFeld(int iChannelNum, int iDataNum,
int iField, unsigned char *szName, int *piType, int *piLength);

Exportiert: _DFCDatBFeld@24
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iDataNum Nummer der Datensatzbeschreibung (wird ab 0 gezählt).
int iField Feld der Datensatzbeschreibung entsprechend Reihenfolge im Setup (wird ab 0 gezählt).
unsigned char *szName Name des Feldes. (Speicher für Name muss min. 17 Byte haben)
int *piType Datentyp des Feldes wie im Setup definiert:
WertBedeutung
1unsigned long 4 Byte
2Date und Time 7 Byte
3wie Typ 4, es sind jedoch nur Ziffern erlaubt
4Alpha-Numerisch ASCII
5Datum 4 Byte Y100,Y,M,D
6Zeit 3 Byte (Stunde, Minute, Sekunde)
int *piLength Länge des Feldes in Byte. Bei Typ 3 und 4 wird die abschließende "0" mitgezählt.
z.B. ASCII-Feld 15 Zeichen, Len = 15 + 1 = 16 Byte
Rückgabewert:
0 Datensatzbeschreibung oder Feldnummer im Gerät nicht vorhanden.
1 Daten wurden übergeben.
Beschreibung:
Daten eines Feldes einer Datensatzbeschreibung abrufen (nur gültig wenn vorher die Funktion "DFCLoadDatensatzbeschreibung" aufgerufen wurde).

 

2.4.8     DFCReadRecord

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCReadRecord(int channelID, int deviceID,
char *buf, int *length, int *err);

Exportiert: _DFCReadRecord@20
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *buf Speicher, in dem die Daten abgelegt werden sollen.
int *length Speicher in dem die Länge der gerade empfangen Daten gespeichert werden soll.
int *err Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
-1 Fehler bei Durchführung.
0 Es liegen keine Datensätze vor.
1 Daten eines Online - Datensatzes gelesen.
2 Wiederholt die Daten eines Online - Datensatzes gelesen.
3 Daten eines Offline - Datensatzes gelesen.
4 Wiederholt die Daten eines Offline - Datensatzes gelesen.
Beschreibung:
Lesen der Daten des nächsten anstehenden Datensatzes. Nachdem der Datensatz gelesen wurde, muss mit DFCQuitRecord dieser quittiert werden. Erst wenn der Datensatz mit DFCQuitRecord erfolgreich quittiert wurde, kann mit einem folgenden Aufruf von DFCReadRecord der nächste anstehende Datensatz gelesen werden.

 

2.4.9     DFCQuitRecord

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCQuitRecord(int channelID, int deviceID, int *err);

Exportiert: _DFCQuitRecord@12
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int *err Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
-1 Fehler bei Durchführung.
0 Keine Quittung nötig.
1 Daten eines Online - Datensatzes quittiert.
2 Wiederholt die Daten eines Online - Datensatzes quittiert.
3 Daten eines Offline - Datensatzes quittiert.
4 Wiederholt die Daten eines Offline - Datensatzes quittiert.
Beschreibung:
Quittieren (löschen) der Daten des zuvor mit DFCReadRecord gelesenen Datensatzes.

 

2.4.10     DFCRestoreRecords

Wird unterstützt ab Firmwareversion:
04.01.06
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCRestoreRecords(int channelID, int deviceID, int *piError);

Exportiert: _DFCRestoreRecords@12
Parameter: 
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert: 
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Setzt den Geräteinternen Datensatzspeicher auf den ersten gültigen Datensatz zurück. Nach erfolgreicher Ausführung des Befehls, können alle Datensätze erneut ausgelesen werden.
Achtung: Ggf. kann durch das Rücksetzen des Datenspeichers eine große Datensatzmenge abrufbreit sein.

 

2.5     Funktionen für Listen

Aufbereiten von Listendaten und laden dieser in die Geräte.

2.5.1     DFCMakeListe

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCMakeListe(
int iChannelNum, int iListNum, int iLineCount, int iListSize,
unsigned char *pucBuf, int iListMemSizeNum);

Exportiert: _DFCMakeListe@24
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iListNum  Ist die Nummer der Liste entsprechend der Listenbeschreibung im Setup. Die erste Listenbeschreibung im Setup hat die Nummer "0".
int iLineCount Anzahl der Zeilen (Datensätze) der Liste.
int iListSize Gesamtgröße der Liste in Byte.
Berechnet sich aus "iLineCount" mal Anzahl der Byte pro Zeile.
unsigned char *pucBuf Zeiger auf die Listendaten.
int iListMemSizeNum Größe des Speichers für Listen.
Muss beim AE III+ immer "0" sein (ist vom Timeboy übernommen). Es sind (100kByte / (256kByte - 12kByte Verwaltungsdaten => 244kByte) für Listen fest eingestellt.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Daten einer Liste in den internen Buffer der DLL schreiben.
Die Listendaten müssen immer exakt mit der Listenbeschreibung im Setup übereinstimmen.  Zeichenketten sind mit NULL (Hexadezimalwert 0x00, nicht zu verwechseln mit ASCII Zeichen "0", Hexadezimalwert 0x30) auf die im Setup vorgegebene Feldlänge zu füllen. Zusätzlich ist die abschließende NULL zu beachten.
Wenn im Setup eine Zeichenkette mit 16 Zeichen angelegt wurde, ist die Feldlänge exakt 17 Byte. Trennzeichen zwischen den Feldern und den Zeilen werden nicht verwendet.

Beispiel:
Liste mit 2 Feldern:
Personalnummer (nur Ziffern) 4 Byte;
Name Zeichenkette (ASCII - Zeichen) 16 Zeichen.
Eine Zeile besteht dann aus genau 4 + 1 + 16 + 1 = 22 Byte. Wenn 3 Zeilen angelegt werden sind exakt 3*22 = 66 Byte anzulegen.

 

2.5.2     DFCLoadListen

 Achtung: 
Bitte beachten Sie, daß in den MasterIV-Geräten ein Flashspeicher zum Einsatz kommt. Laut dem Hersteller kann jeder Speicherblock (512Byte) maximal 100.000 mal beschrieben werden. Die Firmware der Geräte verteilt die Zugriffslast auf die einzelnen Speicherblöcke und markiert intern defekte Blöcke. Es ist jedoch trotz dieses Sicherheitsmechanismus von all zu häufiger Übertragung der Listendaten abzuraten. Die Applikation sollte nur bei Änderungen die Listen neu übertagen und nicht zyklisch permanent.
Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCLoadListen(int iChannelNum, int iBusNum,
int *piError);

Exportiert: _DFCLoadListen@12
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Listendaten aus internen Buffer der DLL in das Gerät laden. Upload der zuvor mit DFCMakeListe erstellten Listendaten. Wenn die Firmwareversion die importierte Menge der Listendaten nicht unterstützt, wird die Fehlermeldung 13 (siehe Tabelle 1.3.3) zurückgegeben. Die Firmwarestände des AEIII+, sowie Firmwarestände des PZE-MasterIV bis 04.00.23 unterstützen 100kByte Listenspeicher, spätere Versionen wie 04.00.23 ca. 256kByte.

 

2.5.3     DFCClrListenBuffer

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCClrListenBuffer(int iChannelNum);

Exportiert: _DFCClrListenBuffer@4
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
Rückgabewert:
keiner  
Beschreibung:
Die Listendaten im Buffer der DLL werden gelöscht.

 

2.5.4     DFCLoadListenbeschreibung

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCLoadListenbeschreibung(int iChannelNum, int iBusNum,
int *piError);

Exportiert: _DFCLoadListenbeschreibung@12
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Listenbeschreibungen aus dem Gerät lesen. Die Listenbeschreibungen werden in der DLL in einen Buffer abgelegt und können mit den Funktionen "DFCListB..." ausgewertet werden.

 

2.5.5     DFCListBCnt

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCListBCnt(int iChannelNum);

Exportiert: _DFCListBCnt@4
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
Rückgabewert:
Anzahl Anzahl gefundener Listenbeschreibungen im Gerät.
Beschreibung:
Anzahl der ausgelesenen Listenbeschreibungen (nur gültig wenn vorher die Funktion "DFCLoadListenbeschreibung" aufgerufen wurde). 

 

2.5.6     DFCListBDatensatz

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCListBDatensatz(int iChannelNum, int iDataNum,
unsigned char *szName, int *piFieldCount, int *piVar);

Exportiert: _DFCListBDatensatz@20
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iDataNum Nummer der Listenbeschreibung aus Setup.
(wird ab 0 gezählt).

Ab DLL - Verison 02.00.22 Bereich:
100 - 103 für Zutrittslisten Version 1. (z. B. 102 für Liste "Personalstamm")
Offsetnummern der Listen siehe DFCMakeEntranceList.

Ab DLL - Version 04.01.00 Bereich:
200 - 206 für Zutrittslisten Version 2. (z. B. 203 für Liste "Time")
Offsetnummern der Listen siehe DFCMakeEntrance2List.
unsigned char *szName Name der Listenbeschreibung.
(Speicher für Name muss min. 17 Byte haben).
int *piFieldCount Anzahl Felder der Liste.
int *piVar Ob Variable Liste. Immer 0. 
(Ist vorhanden wegen Kompatibilität mit Timeboy).
Rückgabewert:
0 Listenbeschreibung im Gerät nicht vorhanden.
1 Daten wurden übergeben.
Beschreibung:
Daten einer Listenbeschreibung abrufen (nur gültig wenn vorher die Funktion "DFCLoadListenbeschreibung" aufgerufen wurde, dieses wird bei Zutrittslisten nicht benötigt). Im Gerät können Listen mit unterschiedlichem Format gespeichert werden. Im Setup - Programm werden die Listen unter dem Punkt "Listenbeschreibungen" festgelegt. Die erste Listenbeschreibung im Setup-Baum hat die Nummer 0, die zweite die Nummer 1 ...

 

2.5.7     DFCListBFeld

Wird unterstützt ab Firmwareversion:
uneingeschränkt
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCListBFeld(int iChannelNum, int iDataNum,
int iField, unsigned char *szName, int *piType, int *piLength);

Exportiert: _DFCListBFeld@24
Parameter: 
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iDataNum Nummer der Listenbeschreibung aus Setup.
(wird ab 0 gezählt).

Ab DLL - Verison 02.00.22 Bereich:
100 - 103 für Zutrittslisten Version 1. (z. B. 102 für Liste "Personalstamm")
Offsetnummern der Listen siehe DFCMakeEntranceList.

Ab DLL - Version 04.01.00 Bereich:
200 - 206 für Zutrittslisten Version 2. (z. B. 203 für Liste "Time")
Offsetnummern der Listen siehe DFCMakeEntrance2List.
int iField Feld der Listenbeschreibung entsprechend Reihenfolge im Setup. 
(wird ab 0 gezählt).
unsigned char *szName Name des Feldes.
(Speicher für Name muss min. 17 Byte haben) 
int *piType Datentyp des Feldes wie im Setup definiert:
WertBedeutung
1unsigned long 4 Byte
2Date und Time 7 Byte
3wie Typ 4, es sind jedoch nur Ziffern erlaubt.
4Alpha-Numerisch ASCII.
5Datum 4 Byte Y100,Y,M,D.
6Zeit 3 Byte (Stunde, Minute, Sekunde).
int *piLength Länge des Feldes in Byte wie im Setup definiert. Bei Typ 3 und 4 wird die anbschliesende "0" mitgezählt.
z.B.: ASCII-Feld 15 Zeichen, Len = 15 + 1 = 16 Byte
Rückgabewert: 
0 Listenbeschreibung oder Feldnummer im Gerät nicht vorhanden.
1 Daten wurden übergeben.
Beschreibung:
Daten eines Feldes einer Listenbeschreibung abrufen (nur gültig wenn vorher die Funktion "DFCLoadListenbeschreibung" aufgerufen wurde, dieses wird bei Zutrittslisten nicht benötigt).

 

2.6     Funktionen für Zutrittskontrolllisten (Version 1)

Aufbereiten und laden von Listendaten für die Zutrittskontrolle.

2.6.1     DFCMakeEntranceList

Wird unterstützt ab Firmwareversion:
03.01.00, 04.00.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCMakeEntranceList(
int iChannelNum, int iListNum, int iLineCount, int iListSize,
unsigned char *pucBuf, int *piError);

Exportiert: _DFCMakeEntranceList@24
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iListNum  Ist die Nummer der Liste entsprechend der Listenbeschreibung im Setup unter Baumeintrag Zutrittskontrolle. Die erste Listenbeschreibung unter dem Eintrag hat die Nummer "0".
int iLineCount Anzahl der Zeilen (Datensätze) der Liste.
int iListSize Gesamtgröße der Liste in Byte.
Berechnet sich aus "iLineCount" mal Anzahl der Byte pro Zeile.
unsigned char *pucBuf Zeiger auf die Listendaten.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Daten einer Liste in den internen Buffer der DLL schreiben.

Die Listendaten müssen immer exakt mit der Listenbeschreibung im Setup übereinstimmen.  Zeichenketten sind mit NULL (Hexadezimalwert 0x00, nicht zu verwechseln mit ASCII Zeichen "0", Hexadezimalwert 0x30) auf die im Setup vorgegebene Feldlänge zu füllen. Zusätzlich ist die abschließende NULL zu beachten.
Wenn im Setup eine Zeichenkette mit 16 Zeichen angelegt wurde, ist die Feldlänge exakt 17 Byte. Trennzeichen zwischen den Feldern und den Zeilen werden nicht verwendet.

Beispiel:
Liste mit 2 Feldern:
Personalnummer Zeichenkette (nur Ziffern) 4 Byte;
Name Zeichenkette (ASCII - Zeichen) 16 Zeichen.
Eine Zeile besteht dann aus genau 4 + 1 + 16 + 1 = 22 Byte. Wenn 3 Zeilen angelegt werden sind exakt 3*22 = 66 Byte anzulegen.

Die Listendaten werden in der DLL für das Gerät komprimiert und sortiert aufbereitet, dadurch kann der Aufruf bei einer Personalliste mit 5120 Einträgen im ungünstigsten Fall bis zu 7 Sekunden dauern.

Bedeutung des Parameters iListNum ist:
0: Zeitzonen (22 Byte) "zu komprimierten (6 Byte) max. 16 DS möglich"
1: Zeitmodelle (35 Byte) "zu komprimierten (3 Byte) max. 32 DS möglich"
2: Personalstamm (19 Byte) "zu komprimierten (16 Byte) max. 5120 DS möglich"
3: Feiertage (16 Byte) "zu komprimierten (6 Byte) max. 64 DS möglich"

 

2.6.2     DFCLoadEntranceList

 Achtung: 
Bitte beachten Sie, daß in den MasterIV-Geräten ein Flashspeicher zum Einsatz kommt. Laut dem Hersteller kann jeder Speicherblock (512Byte) maximal 100.000 mal beschrieben werden. Die Firmware der Geräte verteilt die Zugriffslast auf die einzelnen Speicherblöcke und markiert intern defekte Blöcke. Es ist jedoch trotz dieses Sicherheitsmechanismus von all zu häufiger Übertragung der Listendaten abzuraten. Die Applikation sollte nur bei Änderungen die Listen neu übertagen und nicht zyklisch permanent.
Wird unterstützt ab Firmwareversion:
03.01.00, 04.00.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCLoadEntranceList(int iChannelNum, int iBusNum,
int iListNum, int *piError);

Exportiert: _DFCLoadEntranceList@16
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int iListNum Ist die Nummer der Liste entsprechend der Listenbeschreibung im Setup unter Baumeintrag Zutrittskontrolle. Die erste Listenbeschreibung unter dem Eintrag hat die Nummer "0". Mit "-1" werden alle Listen angesprochen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Listendaten aus internen Buffer der DLL in das Gerät laden. Upload der zuvor erstellten Listendaten. Mit der Angabe "-1" als Listennummer werden alle Listenbuffer übertragen, wobei der Import aller Listen abgeschlossen sein sollte.

 

2.6.3     DFCClearEntranceListBuffer

Wird unterstützt ab Firmwareversion:
03.01.00, 04.00.00
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCClearEntranceListBuffer(int iChannelNum, int iListNum);

Exportiert: _DFCClearEntranceListBuffer@8
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iListNum Ist die Nummer der Liste entsprechend der Listenbeschreibung im Setup unter Baumeintrag Zutrittskontrolle. Die erste Listenbeschreibung unter dem Eintrag hat die Nummer "0". Mit "-1" werden alle Listen angesprochen.
Rückgabewert:
keiner  
Beschreibung:
Der Buffer für die Listendaten wird gelöscht. Mit der Angabe "-1" als Listennummer werden alle für die Zutrittskontrolle zur Verfügung gestellten Buffer gelöscht.

 

2.7     Funktionen für Zutrittskontrolllisten (Version 2)

Aufbereiten und laden von Listendaten für die Zutrittskontrolle.

2.7.1     DFCMakeEntrance2List

Wird unterstützt ab Firmwareversion:
04.01.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCMakeEntrance2List(
int iChannelNum, int iListNum, int iLineCount, int iListSize,
unsigned char *pucBuf, int *piError);

Exportiert: _DFCMakeEntrance2List@24
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iListNum  Ist die Nummer der Liste entsprechend der Listenbeschreibung im Setup unter Baumeintrag Zutrittskontrolle. Die erste Listenbeschreibung unter dem Eintrag hat die Nummer "0".
int iLineCount Anzahl der Zeilen (Datensätze) der Liste.
int iListSize Gesamtgröße der Liste in Byte.
Berechnet sich aus "iLineCount" mal Anzahl der Byte pro Zeile.
unsigned char *pucBuf Zeiger auf die Listendaten.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Daten einer Liste in den internen Buffer der DLL schreiben.

Die Listendaten müssen immer exakt mit der Listenbeschreibung im Setup übereinstimmen.  Zeichenketten sind mit NULL (Hexadezimalwert 0x00, nicht zu verwechseln mit ASCII Zeichen "0", Hexadezimalwert 0x30) auf die im Setup vorgegebene Feldlänge zu füllen. Zusätzlich ist die abschließende NULL zu beachten.
Wenn im Setup eine Zeichenkette mit 16 Zeichen angelegt wurde, ist die Feldlänge exakt 17 Byte. Trennzeichen zwischen den Feldern und den Zeilen werden nicht verwendet.

Beispiel:
Liste mit 2 Feldern:
Personalnummer Zeichenkette (nur Ziffern) 4 Byte;
Name Zeichenkette (ASCII - Zeichen) 16 Zeichen.
Eine Zeile besteht dann aus genau 4 + 1 + 16 + 1 = 22 Byte. Wenn 3 Zeilen angelegt werden sind exakt 3*22 = 66 Byte anzulegen.

Bedeutung des Parameters iListNum ist:
0: Reader (33 Byte)
1: Identification (64 Byte)
2: Location (20 Byte)
3: Time (25 Byte)
4: Holiday (21 Byte)
5: Events (17 Byte)
6: Action (21 Byte)

 

2.7.2     DFCLoadEntrance2List

 Achtung: 
Bitte beachten Sie, daß in den MasterIV-Geräten ein Flashspeicher zum Einsatz kommt. Laut dem Hersteller kann jeder Speicherblock (512Byte) maximal 100.000 mal beschrieben werden. Die Firmware der Geräte verteilt die Zugriffslast auf die einzelnen Speicherblöcke und markiert intern defekte Blöcke. Es ist jedoch trotz dieses Sicherheitsmechanismus von all zu häufiger Übertragung der Listendaten abzuraten. Die Applikation sollte nur bei Änderungen die Listen neu übertagen und nicht zyklisch permanent.
Wird unterstützt ab Firmwareversion:
04.01.00
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCLoadEntrance2List(int iChannelNum, int iBusNum,
int iListNum, int *piError);

Exportiert: _DFCLoadEntrance2List@16
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int iListNum Ist die Nummer der Liste entsprechend der Listenbeschreibung im Setup unter Baumeintrag Zutrittskontrolle 2. Die erste Listenbeschreibung unter dem Eintrag hat die Nummer "0". Mit "-1" werden alle zuvor importierten Listen angesprochen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Listendaten aus internen Buffer der DLL in das Gerät laden. Upload der zuvor erstellten Listendaten. Mit der Angabe "-1" als Listennummer werden alle belegten Listenbuffer übertragen.

 

2.7.3     DFCClearEntrance2ListBuffer

Wird unterstützt ab Firmwareversion:
04.01.00
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCClearEntrance2ListBuffer(int iChannelNum, int iListNum);

Exportiert: _DFCClearEntrance2ListBuffer@8
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iListNum Ist die Nummer der Liste entsprechend der Listenbeschreibung im Setup unter Baumeintrag Zutrittskontrolle. Die erste Listenbeschreibung unter dem Eintrag hat die Nummer "0". Mit "-1" werden alle Listen angesprochen.
Rückgabewert:
keiner  
Beschreibung:
Der Buffer für die Listendaten wird gelöscht. Mit der Angabe "-1" als Listennummer werden alle für die Zutrittskontrolle zur Verfügung gestellten Buffer gelöscht.

 

2.7.4     DFCEntrance2Identification

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCEntrance2Identification(int channelID, int deviceID,
char *TM, char *Id, char *Pin, char *status, int *len, int *piError);

Exportiert: _DFCEntrance2Identification@32
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *TM Der Wert der Zeichenfolge auf den dieser Zeiger verweist, muss dem Format des Feldes "TM" der "Reader" Liste folgen. Er muss demnach immer 3 Ziffern umfassen. 
char *Id Der Wert der Zeichenfolge auf den dieser Zeiger verweist, muss dem Format des Feldes "Id" der "Identification" Liste folgen. Er darf maximal 20 Zeichen lang sein.
char *Pin Der Wert der Zeichenfolge auf den dieser Zeiger verweist, muss dem Format des Feldes "Pin" der "Identification" Liste folgen. Er darf maximal 8 Ziffern beinhalten.
char *status Zeiger auf Zeichenkette die nach erfolgreicher Abarbeitung der Funktion den Status der Zutrittsprüfung erhält. Sie sollten mindestens 5 Zeichen vorsehen.
int *len Als Eingabe die Länge des Buffers auf den der Zeiger *status verweist, als Ausgabe die übergebene Anzahl Zeichen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt
Beschreibung:
Durch Aufruf dieser Funktion kann eine Zutrittsbuchung per DLL ausgeführt werden. Die Funktion lässt sich aus Sicherheitsgründen nur auf Ausweise anwenden die im Feld "ActiveGeneral" der "Identification" Liste entweder den Wert "2" oder "9" eingetragen haben.  

Nähere Informationen für die zu übergebenen Feldwerte (TM, Id, Pin) sowie den zurückgelieferten Status (status) entnehmen Sie bitte dem jeweiligen Handbuch aus dem Kapitel "Zutrittskontrolle 2" und Unterkapitel "Statusmeldungen der Zutrittskontrolle".

 

2.7.5    DFCEntrance2OnlineAction

Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCEntrance2OnlineAction(int channelID, int deviceID,
char *TM, int mask, int type, int duration, int *piError);

Exportiert: _DFCEntrance2OnlineAction@28
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *TM Der Wert der Zeichenfolge auf den dieser Zeiger verweist, muss dem Format des Feldes "TM" der "Reader" Liste folgen. Er muss demnach immer 3 Ziffern umfassen. 
int mask Enthält den Wert der zu schaltenden Komponenten:
Bit Nr.Bedeutung
0Bei gesetztem Bit, wird der Buzzer angesprochen.
1Bei gesetztem Bit, wird die grüne LED angesprochen.
2Bei gesetztem Bit, wird die rote LED angesprochen.
3Bei gesetztem Bit, wird das erste Relais angesprochen.
4Bei gesetztem Bit, wird das zweite Relais angesprochen.
...Unbenutzt. Bitte immer 0.
int type
Nr.Bedeutung
0Aus
1Ein
2Wechsel (600ms an, 600ms aus)
int duration Ist eine Zeitdauer und nur bei type = 1 gültig.
Bedeutung: 0 = ständig ein, 1 - 40 = Sekunden ein.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt
Beschreibung:
Durch Aufruf dieser Funktion kann der Buzzer, LED oder Relais auf einem Zutrittsmodul per DLL geschaltet werden.

 

2.8     Funktionen für Fingerprint

Zugriff auf die Fingertemplates eines evntl. eingebauten Fingerprintmoduls.

2.8.1     DFCFingerprintAppendRecord

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCFingerprintAppendRecord(int channelID, int deviceID,
int type, unsigned char *fingertemplate, int size, int *piError);

Exportiert: _DFCFingerprintAppendRecord@24
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int type Templatetype der übergeben wird.
WertBedeutung
0DIN V66400 (161 Byte)
Byte Nr.Bezeichnung
1..8PID (Es werden Byte 1 bis 4, als 32bit Wert, verwendet.)
9FID
10Quality
11Anzahl Minutiae
12X1
13Y1
14W1
15X2
16Y2
17W2
.....
.....
159X50
160Y50
161W50
1Idencom-Compact (216 Byte)
Byte Nr.Bezeichnung
1..8PID (Es werden Byte 1 bis 4, als 32bit Wert, verwendet.)
9FID
10Quality
11Anzahl Minutiae
12X1
13Y1
14W
15X2
16Y2
.....
.....
159W
160Y41
161W41
... 
unsigned char *fingertemplate Zeiger auf die Templatedaten.
int size Die Länge des Buffers auf den der Zeiger *fingertemplate verweist.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Anfügen eines Fingertemplates an die Datentabelle des Fingerprints.

 

2.8.2     DFCFingerprintGetRecord

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCFingerprintGetRecord(int channelID, int deviceID,
int type, int pid, int fid, unsigned char *fingertemplate,int *size int *piError);

Exportiert: _DFCFingerprintGetRecord@32
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int type Templatetype der übergeben wird.
WertBedeutung
0DIN V66400 (161 Byte)
Byte Nr.Bezeichnung
1..8PID (Es werden Byte 1 bis 4, als 32bit Wert, verwendet.)
9FID
10Quality
11Anzahl Minutiae
12X1
13Y1
14W1
15X2
16Y2
17W2
.....
.....
159X50
160Y50
161W50
1Idencom-Compact (216 Byte)
Byte Nr.Bezeichnung
1..8PID (Es werden Byte 1 bis 4, als 32bit Wert, verwendet.)
9FID
10Quality
11Anzahl Minutiae
12X1
13Y1
14W
15X2
16Y2
.....
.....
159W
160Y41
161W41
... 
int pid Personal Id des zu lesenden Templates.
int fid Finger Id des zu lesenden Templates. Wertebereich (1 - 10)
unsigned char *fingertemplate Zeiger auf die Templatedaten.
int *size Als Eingabe die Länge des Buffers auf den der Zeiger *template verweist, als Ausgabe die übergebene Anzahl Zeichen.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Lesen eines Fingertemplates. Über die eindeutige Kombination aus PID/FID können mit dieser Funktion die entsprechenden Templatedaten ermittelt werden.

 

2.8.3    DFCFingerprintDeleteRecord

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCFingerprintDeleteRecord(int channelID, int deviceID,
int pid, int fid, int *piError);

Exportiert: _DFCFingerprintDeleteRecord@20
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int pid Personal Id des zu löschenden Templates.
int fid Finger Id des zu löschenden Templates. Wertebereich (0, 1 - 10)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt
Beschreibung:
Löschen von Fingertemplates. Sie können einzelne Templates durch Angabe des entsprechenden pid,fid Pärchens löschen. Es ist auch möglich durch Angabe einer pid und einer fid = 0, alle Fingertemplates zu dieser pid zu löschen. Wird eine pid = 0 und fid = 0 angegeben, werden alle Fingertemplates gelöscht.

 

2.8.4    DFCFingerprintList

Wird unterstützt ab Firmwareversion:
04.01.07
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCFingerprintList(int channelID, int deviceID,
int flags, int *piError);

Exportiert: _DFCFingerprintList@16
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int flags Derzeit nicht verwendet. Bitte immer 0 übergeben.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt
Beschreibung:
Erzeugt eine Liste mit dem Namen "FINGERPRINT.IDLIST". In dieser Liste sind alle Datesätze des Fingerprintmoduls aufgeführt. Sie ist zweispaltig und enthält in der ersten Spalte die PID, in der zweiten die FID, des jeweiligen Fingertemplates. Es kann auf sie mit den Routinen aus Kapitel 2.3 zugegriffen werden.

 

2.8.5    DFCFingerprintBackup

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCFingerprintBackup(int channelID, int deviceID,
char *backupFile, int flags, int *piError);

Exportiert: _DFCFingerprintBackup@20
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *backupFile Zeiger auf die Zeichenkette mit der Dateiangabe. Ggf. mit Pfad. Sie gibt die zu erzeugende Backupdatei an.
int flags Derzeit nicht verwendet. Bitte immmer 0 übergeben.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt
Beschreibung:
Legt eine neue Backupdatei an in der alle im Fingerprint-Modul enthaltenen Fingertemplates abgespeichert werden. Eine eventuell vorhandene Datei unter dem angegebenen Namen wird überschrieben. Die Daten können mit der Funktion DFCFingerprintRestore zurückgeschrieben werden.

 

2.8.6    DFCFingerprintRestore

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCFingerprintRestore(int channelID, int deviceID,
char *backupFile, int flags, int *piError);

Exportiert: _DFCFingerprintRestore@20
Parameter:
int channelID Der zu verwendende Kanal. Wertebereich: (1 - 250)
int deviceID Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
char *backupFile Zeiger auf die Zeichenkette mit der Dateiangabe. Ggf. mit Pfad. Sie stellt die einzuspielende Backupdatei dar.
int flags
Bit Nr.Bedeutung
0Bei gesetztem Bit (Wert 1), werden die enthaltenen Fingertemplates beibehalten, bei gelöschtem Bit (Wert 0) wird vor der Übertragung ein Befehl zum Löschen aller enthaltener Templates ausgeführt.
...Unbenutzt. Bitte immer 0.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt
Beschreibung:
Überträgt die angegebene Backupdatei, mit den enthaltenen Fingertemplates, in das Fingerprint-Modul. Dabei werden eventuell bereits enthaltene und gleiche Fingertemplates beibehalten. Die Backupdatei kann mit der Funktion DFCFingerprintBackup erstellt werden.

 

2.9     Funktionen für Timeboylisten

Aufbereiten und laden von Listendaten für angebundene Timeboy-Geräte.

2.9.1     DFCMakeTimeboyList

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCMakeTimeboyList(int iChannelNum, int iGroupID, int iListNum,
int iLineCount, int iListSize, unsigned char *pucBuf, int flags, int *piError);

Exportiert: _DFCMakeTimeboyList@32
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iGroupID  Ist die Timeboy-GruppenID. Bei Verwendung von 0 als GroupID, ist die so übergebene Liste für alle Gruppen gültig. Über eine GroupID größer 0 kann eine eventuell vorhandene Globale Liste überlagert werden.
int iListNum  Ist die Nummer der Liste entsprechend der Listenbeschreibung im Timboysetup unter Baumeintrag Listenbeschreibungen. Die erste Listenbeschreibung unter dem Eintrag hat die Nummer "0".
int iLineCount Anzahl der Zeilen (Datensätze) der Liste.
int iListSize Gesamtgröße der Liste in Byte.
Berechnet sich aus "iLineCount" mal Anzahl der Byte pro Zeile.
unsigned char *pucBuf Zeiger auf die Listendaten.
int flags
Bit Nr.Bedeutung
0Bei gesetztem Bit (Wert 1), wird diese Liste im Mobil-MasterIV gelöscht. Eventuell übergebenen Daten werden ignoriert.
...Unbenutzt. Bitte immer 0.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Daten einer Liste in den internen Buffer der DLL schreiben.

Die Listendaten müssen immer exakt mit der Listenbeschreibung im Setup übereinstimmen.  Zeichenketten sind mit NULL (Hexadezimalwert 0x00, nicht zu verwechseln mit ASCII Zeichen "0", Hexadezimalwert 0x30) auf die im Setup vorgegebene Feldlänge zu füllen. Zusätzlich ist die abschließende NULL zu beachten.
Wenn im Setup eine Zeichenkette mit 16 Zeichen angelegt wurde, ist die Feldlänge exakt 17 Byte. Trennzeichen zwischen den Feldern und den Zeilen werden nicht verwendet.

Beispiel:
Liste mit 2 Feldern:
Personalnummer Zeichenkette (nur Ziffern) 4 Byte;
Name Zeichenkette (ASCII - Zeichen) 16 Zeichen.
Eine Zeile besteht dann aus genau 4 + 1 + 16 + 1 = 22 Byte. Wenn 3 Zeilen angelegt werden sind exakt 3*22 = 66 Byte anzulegen.

 

2.9.2     DFCLoadTimeboyList

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCLoadTimeboyList(int iChannelNum, int iBusNum,
int iGroupID, int iListNum, int reserve, int *piError);

Exportiert: _DFCLoadTimeboyList@24
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iBusNum Die zu verwendende Busnummer. Wertebereich: (1 - 31, 254)
int iGroupID  Ist die Timeboy-GruppenID. Bei Verwendung von 0 als GroupID, ist die so übergebene Liste für alle Gruppen gültig. Über eine GroupID größer 0 kann eine eventuell vorhandene Globale Liste überlagert werden.
int iListNum  Ist die Nummer der Liste entsprechend der Listenbeschreibung im Timeboysetup unter Baumeintrag Listenbeschreibungen. Die erste Listenbeschreibung unter dem Eintrag hat die Nummer "0".
int reserve  Reserviert. Bitte immer eine 0 uebergeben.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Listendaten aus internen Buffer der DLL in das Gerät laden. Upload der zuvor erstellten Listendaten. Mit der Angabe "-1" als Listennummer werden alle belegten Listenbuffer übertragen.

 

2.9.3    DFCClearTimeboyListBuffer

Wird unterstützt ab Firmwareversion:
04.01.04
Deklaration:
extern "C" __declspec(dllexport)
void __stdcall DFCClearTimeboyListBuffer(int iChannelNum,
int iGroupID, int iListNum);

Exportiert: _DFCClearTimeboyListBuffer@12
Parameter:
int iChannelNum Der zu verwendende Kanal. Wertebereich: (1 - 250)
int iGroupID  Ist die Timeboy-GruppenID. Bei Verwendung von 0 als GroupID, ist die so übergebene Liste für alle Gruppen gültig. Über eine GroupID größer 0 kann eine eventuell vorhandene Globale Liste überlagert werden.
int iListNum  Ist die Nummer der Liste entsprechend der Listenbeschreibung im Timeboysetup unter Baumeintrag Listenbeschreibungen. Die erste Listenbeschreibung unter dem Eintrag hat die Nummer "0".
Rückgabewert:
keiner  
Beschreibung:
Der Buffer für die Listendaten wird gelöscht. Mit der Angabe "-1" als GroupID, werden alle Listenpuffer dieser GroupID gelöscht. Mit der Angabe "-1" als Listennummer werden alle Listenpuffer dieser Listennummer, unter Beachtung der GroupID, gelöscht.

 

2.10     Funktionen für Aktive Verbindung

Routinen zum Initialisieren und arbeiten mit Aktiven Verbindungen.

2.10.1     DFCStartActiveConnection

Hinweis: 
Für die Einrichtung der Aktiven Verbindung stehen Ihnen auch Systemvariablen, speziell Variablen für Aktive Verbindung, Präfix: COM zur Verfügung.
Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCStartActiveConnection(char *ip, int port, int deviceID,
int timeout, int aliveTO, int maxConnections, int infoFlags, int reserved, int *piError);

Exportiert: _DFCStartActiveConnection@36
Parameter:
char *ip Adresse der Netzwerkkarte von der eingehende Verbindungen entgegen genommen werden. (Vorgabe: 0.0.0.0, bedeutet alle)
int port Port auf dem eingehende Verbindungsanfragen einlaufen müssen. (Vorgabe: 8000)
int deviceID Busnummer der DLL. (Vorgabe: 31, gilt für alle Kanäle)
int timeout Schnittstellentimeout für das Lesen von Daten. Einheit ist Millisekunden. (Vorgabe 3000ms)
int aliveTO Auszeit um die bestehende Verbindung, auch wenn keine Kommunikation geschieht, sicher zu stellen. (Alive-Ping) (Wird auch über die entsprechende Systemvariable an das Gerät weitergegeben.)
int maxConnections Maximalanzahl gleichzeitig bestehender Verbindungen. (Vorgabe: 50, können maximal 200 sein)
int infoFlags
Bit Nr.Bedeutung
...Unbenutzt. Bitte immer 0 übergeben.
int reserved Reservierter Parameter. (Vorgabe 0)
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Startet das DLL-Modul zur Aktiven Verbindung. An dem angegebenen Listen-Socket wird nach erfolgreicher Ausführung auf eingehende Verbindungsanfragen geprüft und Verarbeitet. Die Annahme von "Datensatzmeldungen" ist standardmäßig aktiv und kann durch Aufruf von DFCSetRecordAvailable wie gewünscht eingestellt werden.

 

2.10.2     DFCStopActiveConnection

Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCStopActiveConnection(int *piError);

Exportiert: _DFCStopActiveConnection@4
Parameter:
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Beendet das DLL-Modul zur Aktiven Verbindung. Alle zur Zeit bestehenden Aktiven Verbindungen werden durch die DLL beendet.

 

2.10.3     DFCGetFirstActiveChannelID

Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetFirstActiveChannelID();

Exportiert: _DFCGetFirstActiveChannelID@0
Parameter:
  Keiner
Rückgabewert:
-1 Es besteht keine Aktiver Kanal.
... Kanalnummer der ersten Aktiven Kanals.
Beschreibung:
Ermittelt bei bestehenden Aktiven Verbindungen die erste Kanalnummer und gibt diese zurück. Durch weitere Aufrufe von DFCGetNextActiveChannelID können alle Aktiven Kanäle ermittelt werden.

2.10.4     DFCGetNextActiveChannelID

Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetNextActiveChannelID(int prev);

Exportiert: _DFCGetNextActiveChannelID@4
Parameter:
int prev Kanalnummer des vorherigen Aktiven Kanals. Siehe auch DFCGetFirstActiveChannelID.
Rückgabewert:
-1 Keine weiterer Aktiver Kanal.
... Kanalnummer des nächsten Aktiven Kanals.
Beschreibung:
Gibt auf eine Kanalnummer eines Aktiven Kanals die ggf. vorhandene nächste zurück. Durch Folgeaufrufe können alle Aktiven Kanäle ermittelt werden.

 

2.10.5     DFCGetInfoActiveChannel

Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCGetInfoActiveChannel(int channelID, char *info, int *infoStringLength);

Exportiert: _DFCGetInfoActiveChannel@12
Parameter:
int channelID Nummer des Aktiven Kanals, für den die Information abgerufen wird.
char *info Zeiger auf die Zeichenkette die den Informationsstring erhält.
Der String enthält eine durch CR (Dezimal 13) getrennte Wertezeichenfolge.
PositionBeschreibung
1Gerätetyp.
0PZE-MasterIV
1ZK-MasterIV
2BDE-MasterIV
3Mobil-MasterIV
4MDE-BoxIV
5AE-MasterIV
2Seriennummer.
...Noch unbenutzt. Bezieht sich auf den Parameter infoFlags von DFCStartActiveConnecion
int *infoStringLength Als Eingabe die Länge des reservierten Buffers auf den der Zeiger *info verweist, als Ausgabe die Länge der übergebenen Zeichenkette.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Gibt zu einer Aktiven Kanalnummer eine Informationszeichenfolge zurück. Diese setzt sich aus verschiedenen Werten zusammen und kann durch den Parameter infoFlags beim Starten des DLL-Moduls zur Aktiven Verbindung mit zusätzlichen Informationen erweitert werden.

 

2.10.6     DFCSetRecordAvailable

Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCSetRecordAvailable(int enable);

Exportiert: _DFCSetRecordAvailable@4
Parameter:
int enable Aktivierung/Deaktivierung der Verarbeitung von Ereignismeldungen "Datensatz vorhanden". (Vorgabe: An)
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Legt fest ob die DLL die Ereignismeldung "Datensatz vorhanden" auswerten und durch die Funktion DFCRecordAvailbale zur Verfügung stellen soll.

 

2.10.7     DFCRecordAvailable

Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCRecordAvailable(int *channelID, int *deviceID, char *infoString, int *infoStringLength, int *piError);

Exportiert: _DFCRecordAvailable@20
Parameter:
int *channelID Zeiger auf die Variable, welche die Kanalnummer der abrufbaren Aktiven Verbindung erhält.
int *deviceID Zeiger auf die Variable, welche die Busnummer des abrufbaren Gerätes erhält.
char *info Siehe Parameter info bei Funktion DFCGetInfoActiveChannel.
int *infoStringLength Als Eingabe die Länge des reservierten Buffers auf den der Zeiger *info verweist, als Ausgabe die Länge der übergebenen Zeichenkette.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Über diese Funktion ist die Abfrage auf die Meldung der verfügbare Datensätze möglich, hierbei wird nicht mit dem Gerät kommuniziert.
Die von den Geräten abgesetzte Meldung, dass Datensätze im Gerät vorliegen wird in eine Prioritätswarteschlange gestellt und kann über diese Funktion abgerufen werden.
Bei Abruf wird die Meldung aus der Warteschlange entfernt und bei einem weiterem Aufruf die nächste geliefert. Über die gelieferten Parameterwerte ist ein gezieltes Abrufen der Datensätze möglich. Grundlegender Ablauf eines Abruf-Tasks:

Mit DFCRecordAvailable auf Verfügbare Datensätze prüfen. Keine direkte Kommunikation mit dem Geräte notwendig.
Mit DFCReadRecord, DFCQuitRecord alle Datensätze abrufen. Kommunikation mit dem Gerät notwendig.

 

2.10.8     DFCBindDeviceToChannel

Wird unterstützt ab Firmwareversion:
04.01.05
Deklaration:
extern "C" __declspec(dllexport)
int __stdcall DFCBindDeviceToChannel(int channelID, int deviceType, int deviceSerial,
 char *deviceIp, int *piError);

Exportiert: _DFCBindDeviceToChannel@20
Parameter:
int channelID Kanalnummer an welche das Gerät gebunden werden soll.
int deviceType Typ des zu bindenden Gerätes. Zu dieser Angabe ist auch die Seriennummer erforderlich (nächster Parameter).
Für eine Liste der zugeordneten Nummer zum Gerätetyp siehe info-Parameter von DFCGetInfoActiveChannel.
Wenn hier eine -1 als Wert übergeben wird und keine deviceIp vorliegt, wird eine eventuelle Bindung zu dem Kanal entfernt.
int deviceSerial Seriennummer des zu bindenden Gerätes.
char *deviceIp IP-Adresse des zu bindenden Gerätes.
int *piError Error erhält eine Fehlernummer nach Tabelle 1.3.3.
Rückgabewert:
0 Fehler bei Durchführung.
1 Erfolgreich durchgeführt.
Beschreibung:
Über diese Funktion kann ein sich Aktiv verbindendes Gerät an eine vorgegebene Kanalnummer gebunden werden. Es kann entweder der Gerätetyp und die Seriennummer oder nur die IP-Adresse angegeben werden. Über die Funktion kann die Bindung auch wieder aufgehoben werden.

 

3. Datenstruktur

Die verwendeten Datenstrukturen werden nachfolgend erklärt.

3.1     Aufbau der Datensätze im ByteArray

Es wird in jedem Datensatz die zugehörige Datensatzbeschreibung aus dem Setup mitgeführt.
Ein an die Anwendung überlieferter Datensatz sieht immer wie folgt aus:

Byte - Nummer: 0 1 2 3... (length-1)
Byte - Inhalt:   DataNum Daten des Datensatzes.

Es werden immer alle Felder eines Datensatzes aufeinanderfolgend und in der im Setup definierten Feldbreite (eventuell plus einem Terminierungszeichen) geliefert. 
Bitte beachten Sie, dass alle als ASCII - Feld definierten Felder ein zusätzliches Terminierungszeichen erhalten, wodurch ein im Setup mit einem Byte definiertes Feld in den "Daten des Datensatzes" zwei Byte umfasst!

Mit Hilfe der Auswertefunktionen für die Datensatzbeschreibungen und Listenbeschreibungen können Sie die "Daten des Datensatzes" interpretieren. Das Terminierungszeichen ist in der Angabe zur Feldbreite des  jeweiligen Datensatzfeldes enthalten.

 

3.2 Datum und Uhrzeit im ByteArray

Das Datum - Uhrzeit Feld in einem Datensatz sieht wie folgt aus:

Byte - Nummer Bedeutung Beispiel: 27.02.1981 15:30:13
0 Jahreszahl Hunderter (0..255) 19
1 Jahreszahl Einer (0..99) 81
2 Monat (0..12) 2
3 Tag (1..31) 27
4 Stunde (0..23) 15
5 Minute (0..59) 30
6 Sekunde (0..59) 13

 

4. Systemvariablen

Die verwendeten Systemvariablen beziehen sich auf verschiedene Softwarebereiche. Jeder Softwarebereich wird über einen entsprechenden Präfix angesprochen, hinter dem der Name der systemvariablen mit einem Punkt getrennt folgt. Sie können über die beiden DLL-Funktionen DFCSetGlobVar und DFCGetGlobVar ggf. geschrieben und gelesen werden.

4.1    Variablen für Mobilfunk, Präfix: _MODEM_MC35i oder MOBILE

Name Informationen
PHONE Tel.Nr. für Einwahl. Bereich: bis 23 Zeichen ASCII. Vorgabe: keine
GPRS oder APN Access Point Name. Bereich: bis 49 Zeichen ASCII. Vorgabe: keine
USER Benutzername für Interneteinwahl. Bereich: bis 20 Zeichen ASCII. Vorgabe: keine
PASSWORD Passwort für Interneteinwahl. Bereich: bis 20 Zeichen ASCII. Vorgabe: keine
HOST Ziel-IP oder Hostnamen. Bereich: bis 59 Zeichen ASCII. Vorgabe: keine
PORT Ziel-Port. Bereich: 1 bis 65535 Zahl. Vorgabe: keine
HTTPSEND Ziel-Pfad (Sendepräfix) Bereich: bis 39 Zeichen ASCII. Vorgabe: keine
ALIVE Sekunden zwischen zwei Alive - Datensätzen. Bereich: 0 = aus, 60 bis 65500, Zahl in Sekunden. Vorgabe: keine
HTTPTIMEOUT Wartezeit nach HTTP-Paketversand auf die Serverantwort. Bereich: 5000 bis 65000, Zahl in Millisekunden. Vorgabe: keine
HTTPTYPE Typ des verwendeten HTTP-Protokoll. (1.0, 1.1, off) Bereich: 3 Zeichen [1.0, 1.1, off] ASCII. Vorgabe: keine
SIMPIN Die zu setzende PIN. Dieser Wert ist Temporär. Bereich: 0 = Nicht übertragen, 1 bis 999999999 Zahl. Vorgabe: keine
SIMPUK Die zu setzende PUK. Dieser Wert ist Temporär. Bereich: 0 = Nicht übertragen, 1 bis 999999999 Zahl. Vorgabe: keine
ROAMING Angabe ob die Einwahl in Fremdnetzen erlaubt ist. Bereich: 0 = Nicht erlaubt, 1 = Erlaubt Zahl. Vorgabe: Erlaubt
RESETTRIGGER Dieser Wert gibt an wie oft in Folge der Status 40 angenommen wird, bevor eine komplette Neueinwahl stattfindet. Bereich: 1 bis 32 Zahl. Vorgabe: 32

4.2    Variablen für Bedienung, Präfix: SERVICE

Name Informationen
DBLINPUT Zeit für Buchungswiederholsperre. Bereich: 0 = Deaktiviert, 1 bis 65499, Zahl in Sekunden. Vorgabe: 60
DEMANDTIMER Timeout zur Tastenumschaltung. Bereich: 5 bis 60, Zahl in Sekunden. Vorgabe: 10

4.3    Variablen für Zutritt, Präfix: ACCESS

Name Informationen
MASTERID Die verwendete Id des Masters der Spalte Reader.ZM. Bereich: 1 bis 9999 Zahl. Vorgabe: 1

4.4    Variablen für Bluetooth, Präfix: BTH

Name Informationen
MODEL Name des Bluetoothmoduls.
VERSION Version des Moduls.
NAME Anzeigename des Moduls.
ADDRESS Adresse des Moduls.
AUTH Nummer der Authentifikation.
MODE Modus des Moduls.

4.5    Variablen für digitale Ein-/Ausgänge, Präfix: IO

Name Informationen
INPUT.[0-7].Count Gibt den Zählerteiler des digitalen Eingangs 0-7 an. Beispiel: IO.INPUT.0.Count für ersten digital Eingang. Bereich: 0 bis 4294967295, Zahl in Impulse. Vorgabe: Aus Setupdaten.
INPUT.[0-7].Timeout Gibt den Timeout des digitalen Eingangs 0-7 an. Beispiel: IO.INPUT.1.Timeout für zweiten digital Eingang. Bereich: 0 bis 65535, Zahl in Sekunden. Vorgabe: Aus Setupdaten.
INPUT.[0-7].Cycle Gibt den Zyklus des digitalen Eingangs 0-7 an. Beispiel: IO.INPUT.2.Cycle für dritten digital Eingang. Bereich: 0 bis 65535, Zahl in Sekunden. Vorgabe: Aus Setupdaten.
INPUT.[0-7].Cavity Gibt die Kavität (pro Impuls n-Teile) des digitalen Eingangs 0-7 an. Beispiel: IO.INPUT.3.Cavity für vierten digital Eingang. Bereich: 0 bis 65535, Zahl in Sekunden. Vorgabe: Aus Setupdaten.
INPUT.[0-7].Strokes Gibt die Hubzahl (n-Impulse pro Teil) des digitalen Eingangs 0-7 an. Beispiel: IO.INPUT.4.Strokes für fünften digital Eingang. Bereich: 0 bis 65535, Zahl in Sekunden. Vorgabe: Aus Setupdaten.

4.6    Variablen zum Präfix: POWER

Name Informationen
BATTERY Gibt den aktuellen Batteriezustand an. Bereich:
ok (=Alles in Ordnung),
unknown (=Prüfung steht nicht zur Verfügung),
low (=Batterie muß getauscht werden um die korrekte Funktionalität zu gewährleisten.).
LOW Spannungsangabe für den Tiefentladeschutz. Bereich: 0 bis 255, Zahl in Volt, wobei die letze Ziffer für die erste Nachkommastelle steht (45 sind 4.5V, 126 sind 12.6V). Vorgabe: 0.
VOLTAGE Aktuelle Versorgungsspannung. Bereich: 0 bis 36, Kommazahl mit einer Nachkommastellte und Einheitszeichen in Volt. Z.b. 12.6V

4.7    Variablen für Aktive Verbindung, Präfix: COM

Name Informationen
ACTIVE Ein-/Ausschalten der Aktiven Verbindung. Bereich: 0=aus, 1=ein, Zahl. Vorgabe: 0
NOTIFY Ein-/Ausschalten der Datensatzmeldung. Bereich: 0=aus, 1=ein, Zahl. Vorgabe: 1
PRIO Priorität des Gerätes, für Warteschlange in DLL. Bereich: 0 bis 65535, Zahl. Vorgabe: 0
HOST Adresse des Remoterechners für die Aktive Verbindung. Bereich: IP/Host. Vorgabe: 0.0.0.0
PORT Portnummer des Remoterechers. Bereich: 0 bis 65535, Zahl. Vorgabe: 8000
RETRY Anzahl der Versuche zum Verbindungsaufbau. Bereich: 0 bis 65535, Zahl. Vorgabe: 3
TIMEOUT Auszeit zwischen den Versuchsblöcken (RETRY). Bereich: 0 bis 4294967295, Zahl in Sekunden. Vorgabe: 900
REPEAT Auszeit zur wiederholten Datensatzmeldung, wenn diese nicht abgerufen wurden. Bereich: 0 bis 4294967295, Zahl in Sekunden. Vorgabe: 60
ALIVE Pinganfrage wenn fuer diese Zeit keine Kommunikation zustande kam. Bereich: 0 bis 4294967295, Zahl in Sekunden. Vorgabe: 0