Dokumentation zur DFComDLL.dll / DFCom_x64.dll  04.03.05.00
df_api.h
gehe zur Dokumentation dieser Datei
1 
7 #ifndef DF_API_H
8 #define DF_API_H
9 
10 #include "df_defines.h"
11 #include "df_connection.h"
12 #include "df_files.h"
13 #include "df_lists.h"
14 #include "df_log.h"
15 #include "df_setup_records.h"
16 #include "df_setup_lists.h"
18 #include "df_access_control.h"
20 #include "df_system_records.h"
21 #include "df_fingerprint.h"
22 #include "df_active_mode.h"
23 
271 DF_API_EXTERN int DF_API_CALL DFCCheckAE( int connectionId, int deviceAddress );
272 
273 
274 
275 #if (DF_API_VERSION >= 0x02000300)
276 
277 
292 DF_API_EXTERN int DF_API_CALL DFCCheckDevice( int connectionId, int deviceAddress, int *errorNumber, int devicePollRetry );
293 
294 #endif
295 
296 
311 DF_API_EXTERN int DF_API_CALL DFCComSetTime( int connectionId, int deviceAddress, unsigned char *dateTimeBuffer );
312 
313 
328 DF_API_EXTERN int DF_API_CALL DFCComGetTime( int connectionId, int deviceAddress, unsigned char *dateTimeBuffer );
329 
330 
350 DF_API_EXTERN int DF_API_CALL DFCComSendMessage( int connectionId, int deviceAddress, unsigned char visibleTime, unsigned char doAction, unsigned char audibleSignal, char *text, int textLength );
351 
352 
368 DF_API_EXTERN int DF_API_CALL DFCComSendInfotext( int connectionId, int deviceAddress, char *text, int textLength );
369 
370 
385 DF_API_EXTERN int DF_API_CALL DFCGetSeriennummer( int connectionId, int deviceAddress, int *errorNumber, int *value );
386 
387 
388 #if (DF_API_VERSION >= 0x02000000)
389 
390 
404 DF_API_EXTERN void DF_API_CALL DFCSetCallBack( int connectionId, int (*functionPointer)(void) );
405 
406 #endif
407 
408 
409 #if (DF_API_VERSION >= 0x02000300)
410 
426 DF_API_EXTERN void DF_API_CALL DFCGetErrorText( int connectionId, int errorNumber, int languageId, char *value, int valueLength );
427 
428 #endif
429 
430 #if (DF_API_VERSION >= 0x02000400)
431 
432 
453 DF_API_EXTERN int DF_API_CALL DFCSetGlobVar( int connectionId, int deviceAddress, unsigned char *name, int nameType, unsigned char *value, int *errorNumber );
454 
455 
477 DF_API_EXTERN int DF_API_CALL DFCGetGlobVar( int connectionId, int deviceAddress, unsigned char *name, int nameType, unsigned char *value, int valueLength, int *errorNumber );
478 
479 #endif
480 
481 #if (DF_API_VERSION >= 0x02000500)
482 
483 
502 DF_API_EXTERN int DF_API_CALL DFCCloseRelay( int connectionId, int deviceAddress, int number, int timeout, int *errorNumber );
503 
504 
523 DF_API_EXTERN int DF_API_CALL DFCGetRelayState( int connectionId, int deviceAddress, int number, int *state, int *timeout, int *errorNumber );
524 
525 
542 DF_API_EXTERN int DF_API_CALL DFCOpenRelay( int connectionId, int deviceAddress, int number, int *errorNumber );
543 #endif
544 
545 #if (DF_API_VERSION >= 0x02000500)
546 
558 DF_API_EXTERN int DF_API_CALL DFCGetDevicePollRetry( int connectionId );
559 
560 #endif
561 
562 
563 #if (DF_API_VERSION >= 0x02001800)
564 
565 DF_API_EXTERN int DF_API_CALL DFCGetVersionFirmware( int connectionId, int deviceAddress, char *value, int *errorNumber );
566 #endif
567 
568 #if (DF_API_VERSION >= 0x02002100)
569 
570 DF_API_EXTERN int DF_API_CALL DFCGetVersionFirmwareFromFile( int connectionId, char *filePath, char *value, int *errorNumber );
571 #endif
572 
573 #if (DF_API_VERSION >= 0x04020300)
574 
591 DF_API_EXTERN int DF_API_CALL DFCReadHardwareInfo( int connectionId, int deviceAddress, char *value, int *valueLength, int flags, int *errorNumber );
592 #endif
593 
594 #if (DF_API_VERSION >= 0x04010600)
595 DF_API_EXTERN int DF_API_CALL DFCSetOptionFirmware( int connectionId, int deviceAddress, int mask, int options, int *errorNumber );
596 DF_API_EXTERN int DF_API_CALL DFCGetOptionFirmware( int connectionId, int deviceAddress, int *mask, int *options, int *errorNumber );
597 #endif
598 
599 #if (DF_API_VERSION >= 0x04010700)
600 DF_API_EXTERN int DF_API_CALL DFCSetFontType( int connectionId, int deviceAddress, int type, int *errorNumber );
601 DF_API_EXTERN int DF_API_CALL DFCPressVirtualKey( int connectionId, int deviceAddress, int keyCode, int flags, int *errorNumber );
602 DF_API_EXTERN int DF_API_CALL DFCGetPasswordKey( int connectionId, int deviceAddress, char *value, int *valueLength, int *errorNumber );
603 DF_API_EXTERN int DF_API_CALL DFCSetPassword( int connectionId, char *value, int *errorNumber );
604 DF_API_EXTERN int DF_API_CALL DFCReset( int connectionId, int deviceAddress, int mode, int *errorNumber );
605 DF_API_EXTERN int DF_API_CALL DFCGetFlashStatus( int connectionId, int deviceAddress, int *value, int *errorNumber );
606 
607 #endif
608 
609 #if (DF_API_VERSION >= 0x04020300)
610 DF_API_EXTERN int DF_API_CALL DFCSetCommunicationPassword( int connectionId, unsigned char *value, int valueLength, int sessionTimeout, int *errorNumber );
611 #endif
612 
613 DF_API_EXTERN int DF_API_CALL DFCRecordVolume( int connectionId, int deviceAddress, int *recordCount, int *memoryUsage, int *memorySize, int *errorNumber );
614 
615 
616 #if (DF_API_VERSION >= 0x04010400)
617 DF_API_EXTERN int DF_API_CALL DFCGetInfo( int connectionId, int deviceAddress, char *name, char *params, char *text, int *textLength, int *errorNumber );
618 
619 DF_API_EXTERN int DF_API_CALL DFCOpenComServerMode( int connectionId, int deviceAddress, char *comm, int baudRate, int byteSize, int parity, int stopBits, int flags, int timeoutToClose, int *errorNumber );
620 DF_API_EXTERN int DF_API_CALL DFCCloseComServerMode( int connectionId, int deviceAddress, int *errorNumber );
621 #endif
622 
623 // ########################################################
624 // ########### FUNKTIONEN FUER ERWEITERUNGEN ##############
625 // ########################################################
626 
627 #if (DF_API_VERSION >= 0x04030001)
628 
629 
644 DF_API_EXTERN int DF_API_CALL DFCVersionLibrary( char *value, int valueLength );
645 
646 #endif
647 
648 // ########################################################
649 // #############* PRIVATE FUNKTIONEN* #################
650 // ########################################################
651 
652 // Funktionen sind nicht dokumentiert.
653 // Sie werden von AESetup oder Talk verwendet.
654 // Unterliegen evntl. Aenderungen.
655 
656 #if defined( USE_PRIVATE )
657 
658 #if defined( _MSC_VER ) && defined( DF_API_EXPORT ) && (DF_API_VERSION >= 0x02000000)
659 
660 HRESULT DllGetVersion( DLLVERSIONINFO *pdvi );
661 
662 #endif
663 
664 #if (DF_API_VERSION >= 0x02000200)
665 
666 DF_API_EXTERN int DF_API_CALL DFCComVersion( int connectionId, int deviceAddress, int *errorNumber );
667 
668 #endif
669 
670 #if (DF_API_VERSION >= 0x03020000)
671 
672 DF_API_EXTERN void* DF_API_CALL DFCGetClass( int connectionId, int classId );
673 
674 #endif
675 
676 #endif // USE_PRIVATE
677 
678 #endif
679 
680 
Deklarationen der Funktionen für die Listen der Zutrittskontrolle Version 2.
Deklarationen für die Funktionen des Systemlogs.
Deklarationen der Funktionen für das Logging der Bibliothek.
Deklarationen für die Funktionen der Setupdatensätze.
DF_API_EXTERN int DF_API_CALL DFCComSetTime(int connectionId, int deviceAddress, unsigned char *dateTimeBuffer)
Setzt das uebergebene Datum und die Uhrzeit in dem Geraet.
Datei beinhaltet alle Defines die von der API benötigt werden.
DF_API_EXTERN int DF_API_CALL DFCComSendMessage(int connectionId, int deviceAddress, unsigned char visibleTime, unsigned char doAction, unsigned char audibleSignal, char *text, int textLength)
Direktes schreiben einer Textnachricht.
DF_API_EXTERN int DF_API_CALL DFCCheckAE(int connectionId, int deviceAddress)
Pruefen ob das Geraet erreichbar ist.
DF_API_EXTERN int DF_API_CALL DFCGetRelayState(int connectionId, int deviceAddress, int number, int *state, int *timeout, int *errorNumber)
Abfragen von aktuellem Zustand und verbleibender Zeit.
Deklarationen für die Listen der Zutrittskontrolle Version 1.
DF_API_EXTERN int DF_API_CALL DFCReadHardwareInfo(int connectionId, int deviceAddress, char *value, int *valueLength, int flags, int *errorNumber)
Die Hardware Info vom Geraet lesen.
Deklarationen für die Funktionen der Geräteverbindungen und deren direktem Zugriff.
DF_API_EXTERN int DF_API_CALL DFCGetSeriennummer(int connectionId, int deviceAddress, int *errorNumber, int *value)
Die Seriennummer aus dem Geraet lesen.
DF_API_EXTERN int DF_API_CALL DFCOpenRelay(int connectionId, int deviceAddress, int number, int *errorNumber)
Oeffnen eines Relais.
Definitionen der Funktionen zur Zutrittskontrolle Version 2.
Deklarationen der Funktionen für die Arbeit mit den Setuplisten.
DF_API_EXTERN int DF_API_CALL DFCSetGlobVar(int connectionId, int deviceAddress, unsigned char *name, int nameType, unsigned char *value, int *errorNumber)
Setzen des Wertes einer Globalen Variablen.
DF_API_EXTERN int DF_API_CALL DFCGetGlobVar(int connectionId, int deviceAddress, unsigned char *name, int nameType, unsigned char *value, int valueLength, int *errorNumber)
Lesen des Wertes einer Globalen Variablen.
DF_API_EXTERN int DF_API_CALL DFCComSendInfotext(int connectionId, int deviceAddress, char *text, int textLength)
Indirektes schreiben einer Textnachricht.
DF_API_EXTERN void DF_API_CALL DFCSetCallBack(int connectionId, int(*functionPointer)(void))
Setzen einer Rueckruffunktion.
Deklarationen der Funktionen für den Zugriff auf enthaltene Listen und deren Veränderung.
DF_API_EXTERN int DF_API_CALL DFCGetDevicePollRetry(int connectionId)
Abfrage der zuletzt mit DFCCheckDevice() benoetigten Versuche.
Deklarationen der Funktionen für den Active-Mode.
DF_API_EXTERN int DF_API_CALL DFCComGetTime(int connectionId, int deviceAddress, unsigned char *dateTimeBuffer)
Holt das Datum und die Uhrzeit aus dem Geraet.
DF_API_EXTERN int DF_API_CALL DFCCheckDevice(int connectionId, int deviceAddress, int *errorNumber, int devicePollRetry)
Pruefen ob das Geraet erreichbar ist.
Deklarationen der Funktionen für das Übertragen und das Bearbeiten von Dateien.
DF_API_EXTERN void DF_API_CALL DFCGetErrorText(int connectionId, int errorNumber, int languageId, char *value, int valueLength)
Aufloesen einer Fehlernummer in seine lesbare Bedeutung.
DF_API_EXTERN int DF_API_CALL DFCCloseRelay(int connectionId, int deviceAddress, int number, int timeout, int *errorNumber)
Schliessen eines angeschlossenen Relais.
DF_API_EXTERN int DF_API_CALL DFCVersionLibrary(char *value, int valueLength)
Ermitteln der Libraryversion.
Deklarationen der Funktionen für die Arbeit mit Fingertemplates.