Datafox DFCom - API 04.03.23
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
df_api.h-Dateireferenz
#include "df_defines.h"
#include "df_access_control.h"
#include "df_access_control_lists.h"
#include "df_access_control_lists_v1.h"
#include "df_active_mode.h"
#include "df_connection.h"
#include "df_files.h"
#include "df_fingerprint.h"
#include "df_lists.h"
#include "df_logging.h"
#include "df_setup_lists.h"
#include "df_setup_records.h"
#include "df_system_records.h"
#include "df_timeboy_lists.h"

gehe zum Quellcode dieser Datei

Funktionen

int DF_API_CALL DFCCheckAE (int connectionNumber, int deviceAddress)
 Prüft ob das Gerät erreichbar ist.
 
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 DFCComSetTime (int connectionNumber, int deviceAddress, const unsigned char *dateTimeBuffer)
 Setzt das übergebene Datum und die Uhrzeit in dem Gerät.
 
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 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 DFCComSendInfotext (int connectionNumber, int deviceAddress, const char *text, int textLength)
 Sendet eine Memonachricht an Geräte.
 
int DF_API_CALL DFCGetSeriennummer (int connectionNumber, int deviceAddress, int *errorNumber, int *value)
 Die Seriennummer des Gerätes auslesen.
 
void DF_API_CALL DFCSetCallBack (int connectionNumber, int(*functionPointer)(void))
 Setzen einer Rückruffunktion.
 
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 DFCSetGlobVar (int connectionNumber, int deviceAddress, const char *name, int nameType, const char *value, int *errorNumber)
 Setzen des Wertes einer Setup- oder Systemvariablen.
 
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.
 
int DF_API_CALL DFCCloseRelay (int connectionNumber, int deviceAddress, int number, int timeout, int *errorNumber)
 Schliessen eines Ausgangs (Relais).
 
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 DFCOpenRelay (int connectionNumber, int deviceAddress, int number, int *errorNumber)
 Öffnen eines Ausgangs (Relais).
 
int DF_API_CALL DFCGetDevicePollRetry (int connectionNumber)
 Abfrage der zuletzt mit DFCCheckDevice() benötigten Anzahl Versuche.
 
int DF_API_CALL DFCGetVersionFirmware (int connectionNumber, int deviceAddress, char *value, int *errorNumber)
 Liefert die im Gerät befindliche Firmwareversion und den Namenskürzel.
 
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 DFCGetOptionFirmware (int connectionNumber, int deviceAddress, int *mask, int *options, int *errorNumber)
 Liest die Werte der Zusatzoptionen zur Firmware.
 
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 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 DFCSetPassword (int connectionNumber, const char *value, int *errorNumber)
 Setzen des zu verwendenden Setuppasswortes für diese Verbindung.
 
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 DFCSetCommunicationPassword (int connectionNumber, const char *value, int valueLength, int sessionTimeout, int *errorNumber)
 Setzen des zu verwendenden Verschlüsselungspasswortes der Kommunikation.
 
int DF_API_CALL DFCRecordVolume (int connectionNumber, int deviceAddress, int *recordCount, int *memoryUsage, int *memorySize, int *errorNumber)
 
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.
 
int DF_API_CALL DFCVersionLibrary (char *value, int valueLength)
 Ermitteln der Libraryversion.
 
DF_API_EXTERN int DF_API_CALL DFCGetLastErrorNumber (int connectionNumber, int deviceAddress)
 Liefert die Fehlernummer welche zuletzt aufgetreten ist.
 
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 DFCBlockTransferResume (int connectionNumber, int deviceAddress)
 Setzt eine bestehende Blockübertragung fort.
 
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.
 
DF_API_EXTERN int DF_API_CALL DFCBlockTransferDiscard (int connectionNumber, int deviceAddress)
 Verwirft eine aktuell laufende Blockübertragung. Die bis dahin übertragenen Daten werden verworfen.
 
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.
 
DF_API_EXTERN int DF_API_CALL DFCGetDeviceId (int connectionNumber, int deviceAddress, int *value)
 Lesen einer eindeutigen Gerätetyp-Kennung, alternativ zur Seriennummer und dem Gerätetypen.
 
DF_API_EXTERN int DF_API_CALL DFPReadHardwareInfo (int connectionId, int deviceAddress, const char *filePath, int flags)
 Die Hardware Info vom Geraet lesen.
 
DF_API_EXTERN int DF_API_CALL DFPWriteDeviceId (int connectionId, int deviceAddress, int deviceId, int flags)
 
DF_API_EXTERN int DF_API_CALL DFPReadDeviceId (int connectionId, int deviceAddress, int *deviceId, int flags)
 
DF_API_EXTERN int DF_API_CALL DFCGetUniqueDeviceId (int connectionNumber, int deviceAddress, char *buffer, int *bufferSize, int flags, int *errorNumber)
 Erzeugt eine eindeutige Geräte-ID.
 

Dokumentation der Funktionen

◆ DFCRecordVolume()

int DF_API_CALL DFCRecordVolume ( int connectionNumber,
int deviceAddress,
int * recordCount,
int * memoryUsage,
int * memorySize,
int * errorNumber )

◆ DFPReadDeviceId()

DF_API_EXTERN int DF_API_CALL DFPReadDeviceId ( int connectionId,
int deviceAddress,
int * deviceId,
int flags )
Beispiele
Example3.cpp.

◆ DFPReadHardwareInfo()

DF_API_EXTERN int DF_API_CALL DFPReadHardwareInfo ( int connectionId,
int deviceAddress,
const char * filePath,
int flags )

Die Hardware Info vom Geraet lesen.

Liest die Hardware Info aus dem Geraet und schreibt sie in eine anzugebende Ini-Datei.

Parameter
connectionIdKommunikationskanalnummer.
deviceAddressBusnummer des anzusprechenden Geraetes.
filePathZeiger auf den Dateinamen der Ini-Datei.
flagsZusatzangaben. (noch unverwendet)
Rückgabe
Ergebnis der Werteermittlung.
Rückgabewerte
0Werte wurden ermittelt und in Ini-Datei abgelegt.
..Fehler bei Werteermittlung.
Beispiele
Example3.cpp.

◆ DFPWriteDeviceId()

DF_API_EXTERN int DF_API_CALL DFPWriteDeviceId ( int connectionId,
int deviceAddress,
int deviceId,
int flags )

© 2003-2024 Datafox GmbH