Datafox DFCom - API  04.03.18
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 connectionNumber, int deviceAddress );
45 
65 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCheckDevice( int connectionNumber, int deviceAddress, int *errorNumber, int devicePollRetry );
66 
85 DF_API_EXTERN_DECORATE int DF_API_CALL DFCComSetTime( int connectionNumber, int deviceAddress, const unsigned char *dateTimeBuffer );
86 
103 DF_API_EXTERN_DECORATE int DF_API_CALL DFCComGetTime( int connectionNumber, int deviceAddress, unsigned char *dateTimeBuffer );
104 
156 DF_API_EXTERN_DECORATE int DF_API_CALL DFCComSendMessage( int connectionNumber, 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 connectionNumber, int deviceAddress, const char *text, int textLength );
178 
199 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetSeriennummer( int connectionNumber, int deviceAddress, int *errorNumber, int *value );
200 
216 DF_API_EXTERN_DECORATE void DF_API_CALL DFCSetCallBack( int connectionNumber, int (*functionPointer)(void) );
217 
239 DF_API_EXTERN_DECORATE void DF_API_CALL DFCGetErrorText( int connectionNumber, int errorNumber, int languageId, char *value, int valueLength );
240 
274 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetGlobVar( int connectionNumber, int deviceAddress, const char *name, int nameType, const char *value, int *errorNumber );
275 
310 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetGlobVar( int connectionNumber, 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 connectionNumber, int deviceAddress, int number, int timeout, int *errorNumber );
332 
352 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetRelayState( int connectionNumber, int deviceAddress, int number, int *state, int *timeout, int *errorNumber );
353 
371 DF_API_EXTERN_DECORATE int DF_API_CALL DFCOpenRelay( int connectionNumber, int deviceAddress, int number, int *errorNumber );
372 
389 
446 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetVersionFirmware( int connectionNumber, int deviceAddress, char *value, int *errorNumber );
447 
448 #ifndef DOXYGEN_SHOULD_SKIP_THIS
449 // \export{_DFCGetVersionFirmwareFromFile@16, DFCGetVersionFirmwareFromFile}
450 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetVersionFirmwareFromFile( int connectionNumber, const char *filePath, char *value, int *errorNumber );
451 
471 DF_API_EXTERN_DECORATE int DF_API_CALL DFCReadHardwareInfo( int connectionNumber, int deviceAddress, char *value,
472  int *valueLength, int flags, int *errorNumber );
473 #endif
474 
475 
476 #if (DF_API_VERSION >= 0x04010600)
531 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetOptionFirmware( int connectionNumber, int deviceAddress, int mask, int options, int *errorNumber );
532 
596 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetOptionFirmware( int connectionNumber, int deviceAddress, int *mask, int *options, int *errorNumber );
597 
598 #endif
599 
600 
601 #if (DF_API_VERSION >= 0x04010700)
602 
636 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetFontType( int connectionNumber, int deviceAddress, int type, int *errorNumber );
637 
686 DF_API_EXTERN_DECORATE int DF_API_CALL DFCPressVirtualKey( int connectionNumber, int deviceAddress, int keyCode, int flags, int *errorNumber );
687 
688 #ifndef DOXYGEN_SHOULD_SKIP_THIS
710 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetPasswordKey( int connectionNumber, int deviceAddress, char *value, int *valueLength, int *errorNumber );
711 #endif
712 
733 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetPassword( int connectionNumber, const char *value, int *errorNumber );
734 
760 DF_API_EXTERN_DECORATE int DF_API_CALL DFCReset( int connectionNumber, int deviceAddress, int mode, int *errorNumber );
761 
762 #ifndef DOXYGEN_SHOULD_SKIP_THIS
782 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetFlashStatus( int connectionNumber, int deviceAddress, int *value, int *errorNumber );
783 #endif
784 
785 #endif
786 
787 #if (DF_API_VERSION >= 0x04020300)
788 
813 DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetCommunicationPassword( int connectionNumber, const char *value, int valueLength, int sessionTimeout, int *errorNumber );
814 
815 #endif
816 
817 // \export{_DFCRecordVolume@24, DFCRecordVolume}
818 DF_API_EXTERN_DECORATE int DF_API_CALL DFCRecordVolume( int connectionNumber, int deviceAddress, int *recordCount, int *memoryUsage, int *memorySize, int *errorNumber );
819 
820 #if (DF_API_VERSION >= 0x04010400)
821 
884 DF_API_EXTERN_DECORATE int DF_API_CALL DFCGetInfo( int connectionNumber, int deviceAddress, const char *name, const char *params,
885  char *text, int *textLength, int *errorNumber );
886 
887 #ifndef DOXYGEN_SHOULD_SKIP_THIS
888 // \export{_DFCOpenComServerMode@40, DFCOpenComServerMode}
889 DF_API_EXTERN_DECORATE int DF_API_CALL DFCOpenComServerMode( int connectionNumber, int deviceAddress, const char *comm,
890  int baudRate, int byteSize, int parity, int stopBits, int flags, int timeoutToClose, int *errorNumber );
891 // \export{_DFCCloseComServerMode@12, DFCCloseComServerMode}
892 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCloseComServerMode( int connectionNumber, int deviceAddress, int *errorNumber );
893 #endif
894 
895 #endif
896 
897 // ########################################################
898 // ########### FUNKTIONEN FUER ERWEITERUNGEN ##############
899 // ########################################################
900 
901 #if (DF_API_VERSION >= 0x04030001)
902 
920 DF_API_EXTERN_DECORATE int DF_API_CALL DFCVersionLibrary( char *value, int valueLength );
921 
922 #endif
923 
924 #ifndef DOXYGEN_SHOULD_SKIP_THIS
925 #if (DF_API_VERSION >= 0x04030500)
926 // \export{_DFCStartTransparencyMode@32, DFCStartTransparencyMode}
927 DF_API_EXTERN_DECORATE int DF_API_CALL DFCStartTransparencyMode( int connectionNumber, int deviceAddress, int id, int flags,
928  unsigned int sizeBufferRead, unsigned int sizeBufferWrite, int timeout, int *errorNumber );
929 
930 // \export{_DFCStopTransparencyMode@12, DFCStopTransparencyMode}
931 DF_API_EXTERN_DECORATE int DF_API_CALL DFCStopTransparencyMode( int connectionNumber, int deviceAddress, int *errorNumber );
932 
933 // \export{_DFCIsTransparencyMode@4, DFCIsTransparencyMode}
934 DF_API_EXTERN_DECORATE int DF_API_CALL DFCIsTransparencyMode( int connectionNumber );
935 
936 #endif
937 
938 
939 #if (DF_API_VERSION >= 0x04030600)
940 // \export{_DFCCustomCommand@36, DFCCustomCommand}
941 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCustomCommand( int connectionNumber, int deviceAddress, int identification, int customCommand, const char *dataIn, int sizeIn, char *dataOut, int *sizeOut, int *errorNumber );
942 
943 #endif
944 #endif
945 
946 #if (DF_API_VERSION >= 0x04030800)
947 
962 DF_API_EXTERN int DF_API_CALL DFCGetLastErrorNumber( int connectionNumber, int deviceAddress );
963 
993 DF_API_EXTERN int DF_API_CALL DFCBlockTransferSetDuration( int connectionNumber, int deviceAddress, int blockTypesAllowed, int duration );
994 
1012 DF_API_EXTERN int DF_API_CALL DFCBlockTransferResume( int connectionNumber, int deviceAddress );
1013 
1042 DF_API_EXTERN int DF_API_CALL DFCBlockTransferGetState( int connectionNumber, int deviceAddress, int *currentType, int *currentState );
1043 
1060 DF_API_EXTERN int DF_API_CALL DFCBlockTransferDiscard( int connectionNumber, int deviceAddress );
1061 
1062 #endif
1063 
1064 #if (DF_API_VERSION >= 0x04030C00)
1099 DF_API_EXTERN int DF_API_CALL DFCReadDataBlock( int connectionNumber, int deviceAddress, const char *name, char *data, int *length, int flags );
1100 #endif
1101 
1102 // ########################################################
1103 // #############* PRIVATE FUNKTIONEN* #################
1104 // ########################################################
1105 
1106 // Funktionen sind nicht dokumentiert.
1107 // Sie werden von AESetup oder Talk verwendet.
1108 // Unterliegen evntl. Aenderungen.
1109 
1110 #if defined( USE_PRIVATE )
1111 
1112 #if defined( _MSC_VER ) && defined( DF_API_EXPORT )
1113 
1114 // \export{DllGetVersion, DllGetVersion}
1115 DF_API_EXTERN HRESULT DF_API_CALL DllGetVersion( DLLVERSIONINFO *pdvi );
1116 
1117 #endif
1118 
1119 // \export{_DFCComVersion@12, DFCComVersion}
1120 DF_API_EXTERN_DECORATE int DF_API_CALL DFCComVersion( int connectionNumber, int deviceAddress, int *errorNumber );
1121 
1122 // \export{_DFCGetClass@8, DFCGetClass}
1123 DF_API_EXTERN_DECORATE void* DF_API_CALL DFCGetClass( int connectionNumber, int classId );
1124 
1125 /*
1126  \brief Ausführen eines Prüfplatzkommandos.
1127 
1128  Über diese Funktion werden der Firmware auszuführende Kommandos gesendet und die Resultate als Ergebnis geliefert.
1129  Die sendbare Anfrage und zu erwartende Antwort hängt von der implementierten Routine auf Firmwareseite ab.
1130 
1131  \ingroup library
1132 
1133  \export{_DFCCommandInspectionStation@36, DFCCommandInspectionStation}
1134 
1135  \note Zu diesem Befehl muss ein entsprechendes zusätzliches Dokument beachtet werden in welchem die übermittelten Daten
1136  beschrieben sind.
1137 
1138  \param[in] connectionNumber Zu verwendende Verbindungsnummer.
1139  \param[in] deviceAddress Anzusprechende Geräteadresse.
1140  \param[in] requestAddress Ein Wert zwischen 0 - 255, der eine Befehlsadresse darstellt.
1141  \param[in] requestParams Eine zu sendende Zeichenfolge, kann auch ein Bytearray sein.
1142  \param[in] requestParamsSize Länge des auf \c requestParams verweisenden Puffers.
1143  \param[out] answerAddress Ein Wert zwischen 0 - 255, der die Antwortadresse darstellt.
1144  \param[out] answerParams Eine zu empfangende Zeichenfolge, kann auch ein Bytearray sein.
1145  \param[in, out] answerParamsSize Als Eingabe die maximal hinter \c answerParams zur verfügbung stehenden Pufferlänge,
1146  als Ausgabe die nach \c answerParams kopierte Anzahl Zeichen.
1147  \param[in] secondsToWaitForAnswer Angabe in Sekunden, wie lange maximal auf die Antwort gewartet wird.
1148 
1149  \returns Liefert 0 bei Erfolgreicher ausführung, ansonsten den auszuwertenden Fehlercode.
1150 */
1151 DF_API_EXTERN_DECORATE int DF_API_CALL DFCCommandInspectionStation( int connectionNumber, int deviceAddress, int requestAddress,
1152  char *requestParams, int requestParamsSize, int *answerAddress, char *answerParams, int *answerParamsSize, int secondsToWaitForAnswer );
1153 
1154 // \export{_DFCPing@16, DFCPing}
1155 DF_API_EXTERN_DECORATE int DF_API_CALL DFCPing( int connectionNumber, int deviceAddress, int attempts, int *errorNumber );
1156 
1157 #endif // USE_PRIVATE
1158 
1159 #endif
1160 
1161 
int DF_API_CALL DFCCloseRelay(int connectionNumber, int deviceAddress, int number, int timeout, int *errorNumber)
Schliessen eines Ausgangs (Relais).
int DF_API_CALL DFCGetDevicePollRetry(int connectionNumber)
Abfrage der zuletzt mit DFCCheckDevice() benötigten Anzahl Versuche.
int DF_API_CALL DFCVersionLibrary(char *value, int valueLength)
Ermitteln der Libraryversion.
void DF_API_CALL DFCSetCallBack(int connectionNumber, int(*functionPointer)(void))
Setzen einer Rückruffunktion.
int DF_API_CALL DFCGetGlobVar(int connectionNumber, int deviceAddress, const char *name, int nameType, char *value, int valueLength, int *errorNumber)
Lesen des Wertes einer Setup- oder Systemvariablen.
DF_API_EXTERN int DF_API_CALL DFCBlockTransferSetDuration(int connectionNumber, int deviceAddress, int blockTypesAllowed, int duration)
Setzt für die entsprechende Geräteadresse oder die gesamte Verbindungsnummer eine Unterbrechungszeit.
DF_API_EXTERN int DF_API_CALL DFCReadDataBlock(int connectionNumber, int deviceAddress, const char *name, char *data, int *length, int flags)
Lesen eines Datenblocks. Dieses kann der Wert einer Systemvariablen oder der Inhalt einer Datei sein.
int DF_API_CALL DFCComGetTime(int connectionNumber, int deviceAddress, unsigned char *dateTimeBuffer)
Liest das Datum und die Uhrzeit aus dem Gerät.
int DF_API_CALL DFCGetInfo(int connectionNumber, int deviceAddress, const char *name, const char *params, char *text, int *textLength, int *errorNumber)
Lesen der Information eines bestimmten Moduls.
DF_API_EXTERN int DF_API_CALL DFCGetLastErrorNumber(int connectionNumber, int deviceAddress)
Liefert die Fehlernummer welche zuletzt aufgetreten ist.
int DF_API_CALL DFCComSendMessage(int connectionNumber, int deviceAddress, unsigned char visibleTime, unsigned char doAction, unsigned char audibleSignal, const char *text, int textLength)
Sendet eine Meldung ggf. zur Anzeige auf einem Display.
int DF_API_CALL DFCSetOptionFirmware(int connectionNumber, int deviceAddress, int mask, int options, int *errorNumber)
Setzt benötigte Zusatzoptionen der Firmware.
int DF_API_CALL DFCGetRelayState(int connectionNumber, int deviceAddress, int number, int *state, int *timeout, int *errorNumber)
Abfragen des aktuellen Zustandes und der verbleibenden Zeit eines geschalteten Ausgangs (Relais).
int DF_API_CALL DFCGetSeriennummer(int connectionNumber, int deviceAddress, int *errorNumber, int *value)
Die Seriennummer des Gerätes auslesen.
int DF_API_CALL DFCPressVirtualKey(int connectionNumber, int deviceAddress, int keyCode, int flags, int *errorNumber)
Über diese Funktion können Sie einen Tastendruck auslösen.
int DF_API_CALL DFCRecordVolume(int connectionNumber, int deviceAddress, int *recordCount, int *memoryUsage, int *memorySize, int *errorNumber)
int DF_API_CALL DFCComSetTime(int connectionNumber, int deviceAddress, const unsigned char *dateTimeBuffer)
Setzt das übergebene Datum und die Uhrzeit in dem Gerät.
int DF_API_CALL DFCCheckDevice(int connectionNumber, int deviceAddress, int *errorNumber, int devicePollRetry)
Prüft ob das Gerät erreichbar ist.
int DF_API_CALL DFCGetOptionFirmware(int connectionNumber, int deviceAddress, int *mask, int *options, int *errorNumber)
Liest die Werte der Zusatzoptionen zur Firmware.
DF_API_EXTERN int DF_API_CALL DFCBlockTransferGetState(int connectionNumber, int deviceAddress, int *currentType, int *currentState)
Ruft den Typen und Zustand der ggf. vorhandenen Blockübertragung ab.
int DF_API_CALL DFCReset(int connectionNumber, int deviceAddress, int mode, int *errorNumber)
Reset je nach gewähltem Modus durchführen.
int DF_API_CALL DFCSetGlobVar(int connectionNumber, int deviceAddress, const char *name, int nameType, const char *value, int *errorNumber)
Setzen des Wertes einer Setup- oder Systemvariablen.
DF_API_EXTERN int DF_API_CALL DFCBlockTransferDiscard(int connectionNumber, int deviceAddress)
Verwirft eine aktuell laufende Blockübertragung. Die bis dahin übertragenen Daten werden verforfen.
int DF_API_CALL DFCOpenRelay(int connectionNumber, int deviceAddress, int number, int *errorNumber)
Öffnen eines Ausgangs (Relais).
int DF_API_CALL DFCSetCommunicationPassword(int connectionNumber, const char *value, int valueLength, int sessionTimeout, int *errorNumber)
Setzen des zu verwendenden Verschlüsselungspasswortes der Kommunikation.
void DF_API_CALL DFCGetErrorText(int connectionNumber, int errorNumber, int languageId, char *value, int valueLength)
Auflösen einer Fehlernummer in seine Textentsprechung.
int DF_API_CALL DFCComSendInfotext(int connectionNumber, int deviceAddress, const char *text, int textLength)
Sendet eine Memonachricht an Geräte.
DF_API_EXTERN int DF_API_CALL DFCBlockTransferResume(int connectionNumber, int deviceAddress)
Setzt eine bestehende Blockübertragung fort.
int DF_API_CALL DFCSetPassword(int connectionNumber, const char *value, int *errorNumber)
Setzen des zu verwendenden Setuppasswortes für diese Verbindung.
int DF_API_CALL DFCCheckAE(int connectionNumber, int deviceAddress)
Prüft ob das Gerät erreichbar ist.
int DF_API_CALL DFCSetFontType(int connectionNumber, int deviceAddress, int type, int *errorNumber)
Setzt den zu verwendenden Schrifttyp zur Darstellung der Nachrichten.
int DF_API_CALL DFCGetVersionFirmware(int connectionNumber, int deviceAddress, char *value, int *errorNumber)
Liefert die im Gerät befindliche Firmwareversion und den Namenskürzel.
#define DF_API_CALL
Definition: df_defines.h:80
#define DF_API_EXTERN_DECORATE
Definition: df_defines.h:78
#define DF_API_EXTERN
Definition: df_defines.h:79

© 2003-2021 Datafox GmbH