Datafox DFCom - API  04.03.11.00
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
df_api.h
gehe zur Dokumentation dieser Datei
1 /*
2  \brief Hauptinclude mit den allgemeinen Funktionen und Einbindung aller Untermodule.
3 
4  \author Bernd Ottmann
5  \date 21.02.2003
6 */
7 #pragma once
8 #ifndef DATAFOX_API_H
9 #ifndef DOXYGEN_SHOULD_SKIP_THIS
10 #define DATAFOX_API_H
11 #endif
12 
13 #include "df_defines.h"
14 #include "df_access_control.h"
17 #include "df_active_mode.h"
18 #include "df_connection.h"
19 #include "df_defines.h"
20 #include "df_files.h"
21 #include "df_fingerprint.h"
22 #include "df_lists.h"
23 #include "df_logging.h"
24 #include "df_setup_lists.h"
25 #include "df_setup_records.h"
26 #include "df_system_records.h"
27 #include "df_timeboy_lists.h"
28 
44 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCheckAE( int connectionId, int deviceAddress );
45 
65 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCheckDevice( int connectionId, int deviceAddress, int *errorNumber, int devicePollRetry );
66 
85 DF_API_EXTERN_DECORATE int DF_API_CALL DFCComSetTime( int connectionId, int deviceAddress, const unsigned char *dateTimeBuffer );
86 
103 DF_API_EXTERN_DECORATE int DF_API_CALL DFCComGetTime( int connectionId, int deviceAddress, unsigned char *dateTimeBuffer );
104 
156 DF_API_EXTERN_DECORATE int DF_API_CALL DFCComSendMessage( int connectionId, int deviceAddress, unsigned char visibleTime,
157  unsigned char doAction, unsigned char audibleSignal, const char *text, int textLength );
158 
177 DF_API_EXTERN_DECORATE int DF_API_CALL DFCComSendInfotext( int connectionId, int deviceAddress, const char *text, int textLength );
178 
199 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetSeriennummer( int connectionId, int deviceAddress, int *errorNumber, int *value );
200 
216 DF_API_EXTERN_DECORATE void DF_API_CALL DFCSetCallBack( int connectionId, int (*functionPointer)(void) );
217 
239 DF_API_EXTERN_DECORATE void DF_API_CALL DFCGetErrorText( int connectionId, int errorNumber, int languageId, char *value, int valueLength );
240 
274 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetGlobVar( int connectionId, int deviceAddress, const char *name, int nameType, const char *value, int *errorNumber );
275 
310 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetGlobVar( int connectionId, int deviceAddress, const char *name, int nameType, char *value, int valueLength, int *errorNumber );
311 
331 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCloseRelay( int connectionId, int deviceAddress, int number, int timeout, int *errorNumber );
332 
352 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetRelayState( int connectionId, int deviceAddress, int number, int *state, int *timeout, int *errorNumber );
353 
371 DF_API_EXTERN_DECORATE int DF_API_CALL DFCOpenRelay( int connectionId, int deviceAddress, int number, int *errorNumber );
372 
389 
435 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetVersionFirmware( int connectionId, int deviceAddress, char *value, int *errorNumber );
436 
437 #ifndef DOXYGEN_SHOULD_SKIP_THIS
438 // \export{_DFCGetVersionFirmwareFromFile@16, DFCGetVersionFirmwareFromFile}
439 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetVersionFirmwareFromFile( int connectionId, const char *filePath, char *value, int *errorNumber );
440 
460 DF_API_EXTERN_DECORATE int DF_API_CALL DFCReadHardwareInfo( int connectionId, int deviceAddress, char *value,
461  int *valueLength, int flags, int *errorNumber );
462 
463 #if (DF_API_VERSION >= 0x04010600)
464 // \export{_DFCSetOptionFirmware@20, DFCSetOptionFirmware}
465 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetOptionFirmware( int connectionId, int deviceAddress, int mask, int options, int *errorNumber );
466 
467 // \export{_DFCGetOptionFirmware@20, DFCGetOptionFirmware}
468 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetOptionFirmware( int connectionId, int deviceAddress, int *mask, int *options, int *errorNumber );
469 
470 #endif
471 #endif
472 
473 #if (DF_API_VERSION >= 0x04010700)
474 
508 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetFontType( int connectionId, int deviceAddress, int type, int *errorNumber );
509 
558 DF_API_EXTERN_DECORATE int DF_API_CALL DFCPressVirtualKey( int connectionId, int deviceAddress, int keyCode, int flags, int *errorNumber );
559 
560 #ifndef DOXYGEN_SHOULD_SKIP_THIS
561 
582 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetPasswordKey( int connectionId, int deviceAddress, char *value, int *valueLength, int *errorNumber );
583 #endif
584 
605 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetPassword( int connectionId, const char *value, int *errorNumber );
606 
632 DF_API_EXTERN_DECORATE int DF_API_CALL DFCReset( int connectionId, int deviceAddress, int mode, int *errorNumber );
633 
634 #ifndef DOXYGEN_SHOULD_SKIP_THIS
635 
654 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetFlashStatus( int connectionId, int deviceAddress, int *value, int *errorNumber );
655 #endif
656 
657 #endif
658 
659 #if (DF_API_VERSION >= 0x04020300)
660 
685 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetCommunicationPassword( int connectionId, const char *value, int valueLength, int sessionTimeout, int *errorNumber );
686 
687 #endif
688 
689 // \export{_DFCRecordVolume@24, DFCRecordVolume}
690 DF_API_EXTERN_DECORATE int DF_API_CALL DFCRecordVolume( int connectionId, int deviceAddress, int *recordCount, int *memoryUsage, int *memorySize, int *errorNumber );
691 
692 #if (DF_API_VERSION >= 0x04010400)
693 
756 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetInfo( int connectionId, int deviceAddress, const char *name, const char *params,
757  char *text, int *textLength, int *errorNumber );
758 
759 #ifndef DOXYGEN_SHOULD_SKIP_THIS
760 // \export{_DFCOpenComServerMode@40, DFCOpenComServerMode}
761 DF_API_EXTERN_DECORATE int DF_API_CALL DFCOpenComServerMode( int connectionId, int deviceAddress, const char *comm,
762  int baudRate, int byteSize, int parity, int stopBits, int flags, int timeoutToClose, int *errorNumber );
763 // \export{_DFCCloseComServerMode@12, DFCCloseComServerMode}
764 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCloseComServerMode( int connectionId, int deviceAddress, int *errorNumber );
765 #endif
766 
767 #endif
768 
769 // ########################################################
770 // ########### FUNKTIONEN FUER ERWEITERUNGEN ##############
771 // ########################################################
772 
773 #if (DF_API_VERSION >= 0x04030001)
774 
792 DF_API_EXTERN_DECORATE int DF_API_CALL DFCVersionLibrary( char *value, int valueLength );
793 
794 #endif
795 
796 #ifndef DOXYGEN_SHOULD_SKIP_THIS
797 #if (DF_API_VERSION >= 0x04030500)
798 // \export{_DFCStartTransparencyMode@32, DFCStartTransparencyMode}
799 DF_API_EXTERN_DECORATE int DF_API_CALL DFCStartTransparencyMode( int connectionId, int deviceAddress, int id, int flags,
800  unsigned int sizeBufferRead, unsigned int sizeBufferWrite, int timeout, int *errorNumber );
801 
802 // \export{_DFCStopTransparencyMode@12, DFCStopTransparencyMode}
803 DF_API_EXTERN_DECORATE int DF_API_CALL DFCStopTransparencyMode( int connectionId, int deviceAddress, int *errorNumber );
804 
805 // \export{_DFCIsTransparencyMode@4, DFCIsTransparencyMode}
806 DF_API_EXTERN_DECORATE int DF_API_CALL DFCIsTransparencyMode( int connectionId );
807 
808 #endif
809 
810 
811 #if (DF_API_VERSION >= 0x04030600)
812 // \export{_DFCCustomCommand@36, DFCCustomCommand}
813 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCustomCommand( int connectionId, int deviceAddress, int identification, int customCommand, const char *dataIn, int sizeIn, char *dataOut, int *sizeOut, int *errorNumber );
814 
815 #endif
816 #endif
817 
818 #if (DF_API_VERSION >= 0x04030800)
819 
834 DF_API_EXTERN int DF_API_CALL DFCGetLastErrorNumber( int connectionId, int deviceAddress );
835 
865 DF_API_EXTERN int DF_API_CALL DFCBlockTransferSetDuration( int connectionId, int deviceAddress, int blockTypesAllowed, int duration );
866 
884 DF_API_EXTERN int DF_API_CALL DFCBlockTransferResume( int connectionId, int deviceAddress );
885 
914 DF_API_EXTERN int DF_API_CALL DFCBlockTransferGetState( int connectionId, int deviceAddress, int *currentType, int *currentState );
915 
932 DF_API_EXTERN int DF_API_CALL DFCBlockTransferDiscard( int connectionId, int deviceAddress );
933 
934 #endif
935 
936 // ########################################################
937 // #############* PRIVATE FUNKTIONEN* #################
938 // ########################################################
939 
940 // Funktionen sind nicht dokumentiert.
941 // Sie werden von AESetup oder Talk verwendet.
942 // Unterliegen evntl. Aenderungen.
943 
944 #if defined( USE_PRIVATE )
945 
946 #if defined( _MSC_VER ) && defined( DF_API_EXPORT )
947 
948 // \export{DllGetVersion, DllGetVersion}
949 DF_API_EXTERN HRESULT DF_API_CALL DllGetVersion( DLLVERSIONINFO *pdvi );
950 
951 #endif
952 
953 // \export{_DFCComVersion@12, DFCComVersion}
954 DF_API_EXTERN_DECORATE int DF_API_CALL DFCComVersion( int connectionId, int deviceAddress, int *errorNumber );
955 
956 // \export{_DFCGetClass@8, DFCGetClass}
957 DF_API_EXTERN_DECORATE void* DF_API_CALL DFCGetClass( int connectionId, int classId );
958 
959 // \export{_DFCCommandInspectionStation@36, DFCCommandInspectionStation}
960 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCommandInspectionStation( int connectionId, int deviceAddress, int requestAddress,
961  char *requestParams, int requestParamsSize, int *answerAddress, char *answerParams, int *answerParamsSize, int secondsToWaitForAnswer );
962 
963 // \export{_DFCPing@16, DFCPing}
964 DF_API_EXTERN_DECORATE int DF_API_CALL DFCPing( int connectionId, int deviceAddress, int attempts, int *errorNumber );
965 
966 #endif // USE_PRIVATE
967 
968 #endif
969 
970 
int DF_API_CALL DFCGetSeriennummer(int connectionId, int deviceAddress, int *errorNumber, int *value)
Die Seriennummer des Gerätes auslesen.
#define DF_API_EXTERN_DECORATE
Definition: df_defines.h:78
int DF_API_CALL DFCGetVersionFirmware(int connectionId, int deviceAddress, char *value, int *errorNumber)
Liefert die im Gerät befindliche Firmwareversion und den Namenskürzel.
int DF_API_CALL DFCSetCommunicationPassword(int connectionId, const char *value, int valueLength, int sessionTimeout, int *errorNumber)
Setzen des zu verwendenden Verschlüsselungspasswortes der Kommunikation.
int DF_API_CALL DFCPressVirtualKey(int connectionId, int deviceAddress, int keyCode, int flags, int *errorNumber)
Über diese Funktion können Sie einen Tastendruck auslösen.
int DF_API_CALL DFCCloseRelay(int connectionId, int deviceAddress, int number, int timeout, int *errorNumber)
Schliessen eines Ausgangs (Relais).
DF_API_EXTERN int DF_API_CALL DFCBlockTransferSetDuration(int connectionId, int deviceAddress, int blockTypesAllowed, int duration)
Setzt für die entsprechende Geräteadresse oder die gesamte Verbindungs-Id eine Unterbrechungszeit.
int DF_API_CALL DFCSetFontType(int connectionId, int deviceAddress, int type, int *errorNumber)
Setzt den zu verwendenden Schrifttyp zur Darstellung der Nachrichten.
int DF_API_CALL DFCOpenRelay(int connectionId, int deviceAddress, int number, int *errorNumber)
Öffnen eines Ausgangs (Relais).
DFComDLL als c _DFCRecordVolume n DFCom_x64 als c DFCRecordVolume int DF_API_CALL DFCRecordVolume(int connectionId, int deviceAddress, int *recordCount, int *memoryUsage, int *memorySize, int *errorNumber)
int DF_API_CALL DFCComSendInfotext(int connectionId, int deviceAddress, const char *text, int textLength)
Sendet eine Memonachricht an Geräte.
DF_API_EXTERN int DF_API_CALL DFCBlockTransferResume(int connectionId, int deviceAddress)
Setzt eine bestehende Blockübertragung fort.
DF_API_EXTERN int DF_API_CALL DFCBlockTransferDiscard(int connectionId, int deviceAddress)
Verwirft eine aktuell laufende Blockübertragung. Die bis dahin übertragenen Daten werden verforfen...
int DF_API_CALL DFCReset(int connectionId, int deviceAddress, int mode, int *errorNumber)
Reset je nach gewähltem Modus durchführen.
int DF_API_CALL DFCCheckAE(int connectionId, int deviceAddress)
Prüft ob das Gerät erreichbar ist.
int DF_API_CALL DFCGetInfo(int connectionId, int deviceAddress, const char *name, const char *params, char *text, int *textLength, int *errorNumber)
Lesen der Information eines bestimmten Moduls.
int DF_API_CALL DFCVersionLibrary(char *value, int valueLength)
Ermitteln der Libraryversion.
DF_API_EXTERN int DF_API_CALL DFCBlockTransferGetState(int connectionId, int deviceAddress, int *currentType, int *currentState)
Ruft den Typen und Zustand der ggf. vorhandenen Blockübertragung ab.
#define DF_API_EXTERN
Definition: df_defines.h:79
int DF_API_CALL DFCGetDevicePollRetry(int connectionId)
Abfrage der zuletzt mit DFCCheckDevice() benötigten Anzahl Versuche.
void DF_API_CALL DFCSetCallBack(int connectionId, int(*functionPointer)(void))
Setzen einer Rückruffunktion.
int DF_API_CALL DFCCheckDevice(int connectionId, int deviceAddress, int *errorNumber, int devicePollRetry)
Prüft ob das Gerät erreichbar ist.
int DF_API_CALL DFCComGetTime(int connectionId, int deviceAddress, unsigned char *dateTimeBuffer)
Liest das Datum und die Uhrzeit aus dem Gerät.
int DF_API_CALL DFCSetGlobVar(int connectionId, int deviceAddress, const char *name, int nameType, const char *value, int *errorNumber)
Setzen des Wertes einer Setup- oder Systemvariablen.
int DF_API_CALL DFCGetRelayState(int connectionId, int deviceAddress, int number, int *state, int *timeout, int *errorNumber)
Abfragen des aktuellen Zustandes und der verbleibenden Zeit eines geschalteten Ausgangs (Relais)...
#define DF_API_CALL
Definition: df_defines.h:80
int DF_API_CALL DFCSetPassword(int connectionId, const char *value, int *errorNumber)
Setzen des zu verwendenden Setuppasswortes für diese Verbindung.
DF_API_EXTERN int DF_API_CALL DFCGetLastErrorNumber(int connectionId, int deviceAddress)
Liefert die Fehlernummer welche zuletzt aufgetreten ist.
int DF_API_CALL DFCComSetTime(int connectionId, int deviceAddress, const unsigned char *dateTimeBuffer)
Setzt das übergebene Datum und die Uhrzeit in dem Gerät.
void DF_API_CALL DFCGetErrorText(int connectionId, int errorNumber, int languageId, char *value, int valueLength)
Auflösen einer Fehlernummer in seine Textentsprechung.
int DF_API_CALL DFCComSendMessage(int connectionId, int deviceAddress, unsigned char visibleTime, unsigned char doAction, unsigned char audibleSignal, const char *text, int textLength)
Sendet eine Meldung ggf. zur Anzeige auf einem Display.
int DF_API_CALL DFCGetGlobVar(int connectionId, int deviceAddress, const char *name, int nameType, char *value, int valueLength, int *errorNumber)
Lesen des Wertes einer Setup- oder Systemvariablen.

© 2003-2018 Datafox GmbH