df_connection.h

gehe zur Dokumentation dieser Datei

/*
    \brief Deklarationen für die Funktionen der Geräteverbindungen und deren direktem Zugriff.
 
    \author Bernd Ottmann
    \date   21.02.2003
*/
#pragma once
#ifndef DATAFOX_CONNECTION_H
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define DATAFOX_CONNECTION_H
#endif
 
#include "df_defines.h"
 
#ifdef DOC_LANG_EN
#else
#endif
DF_API_EXTERN_DECORATE int DF_API_CALL DFCComInit( int connectionNumber );
 
#ifdef DOC_LANG_EN
#else
#endif
DF_API_EXTERN_DECORATE int DF_API_CALL DFCComOpenSerial( int connectionNumber, const char *commPort, int baudRate, int timeout );
 
#ifdef DOC_LANG_EN
#else
#endif
DF_API_EXTERN_DECORATE int DF_API_CALL DFCComOpen( int connectionNumber, const char *hostAddress );
 
 
#ifdef DOC_LANG_EN
#else
#endif
DF_API_EXTERN_DECORATE int DF_API_CALL DFCComOpenSocket( int connectionNumber, const char *hostAddress, int portNumber, int timeout );
 
#ifdef DOC_LANG_EN
#else
#endif
DF_API_EXTERN_DECORATE int DF_API_CALL DFCComOpenIV( int connectionNumber, int deviceAddress, int connectionType,
                                                    const char *connectionString, int connectionValue, int comunicationReadTimeout );
 
#ifdef DOC_LANG_EN
#else
#endif
DF_API_EXTERN_DECORATE void DF_API_CALL DFCComClose( int connectionNumber );
 
#if (DF_API_VERSION >= 0x04030000)
 
#ifdef DOC_LANG_EN
#else
#endif
DF_API_EXTERN_DECORATE int DF_API_CALL DFCIsChannelOpen( int connectionNumber );
 
#endif
 
#ifdef DOC_LANG_EN
#else
#endif
DF_API_EXTERN_DECORATE int DF_API_CALL DFCWrite( int connectionNumber, const char *buffer, int toWrite, int *written, int *errorNumber );
 
#ifdef DOC_LANG_EN
#else
#endif
DF_API_EXTERN_DECORATE int DF_API_CALL DFCRead( int connectionNumber, char *buffer, int toRead, int *read, int *errorNumber );
 
// ########################################################
// #############* PRIVATE FUNKTIONEN* #################
// ########################################################
 
// Funktionen sind nicht dokumentiert.
// Sie werden von AESetup oder Talk verwendet.
// Unterliegen evntl. Aenderungen.
 
#if defined( USE_PRIVATE )
 
//    \export{_DFCComUseHandle@8, DFCComUseHandle}
DF_API_EXTERN_DECORATE int DF_API_CALL DFCComUseHandle( int connectionNumber, HANDLE commHandle );
 
//    \export{_DFCComReleaseHandle@4, DFCComReleaseHandle}
DF_API_EXTERN_DECORATE int DF_API_CALL DFCComReleaseHandle( int connectionNumber );
 
//    \export{_DFCGetComPort@4, DFCGetComPort}
DF_API_EXTERN_DECORATE HANDLE DF_API_CALL DFCGetComPort( int connectionNumber );
 
//    \export{_DFCSetComPort@20, DFCSetComPort}
DF_API_EXTERN_DECORATE int DF_API_CALL DFCSetComPort( int connectionNumber, HANDLE handle, int isSocket, int value, int timeout );
 
#endif // USE_PRIVATE
 
#endif