CanSetting.h

Go to the documentation of this file.

/************************************************
*
*  CROSSCONTROL AUX API
*
*  CanSetting.h
*
*  Version 2.7.2.0, 2014-08-25
*
*  (c) maximatecc 2013
*
*  File description: 
*  Can settings 
*
*  Use the function GetCanSetting() to get a handle to pass on to the other functions. 
*  Use the method CanSetting_release(CANSETTINGHANDLE) to return the handle.
*
*  Example Usage:
*  @include cansetting_example.cpp
*
************************************************/
#ifndef CC_CAN_SETTING_H 
#define CC_CAN_SETTING_H

#include "CCAuxErrors.h"
#include "CCPlatform.h"

#ifdef __cplusplus
namespace CrossControl {
#endif

  typedef void* CANSETTINGHANDLE;


  EXTERN_C
    CCAUXDLL_API
    CANSETTINGHANDLE
    CCAUXDLL_CALLING_CONV
    GetCanSetting(void);

  EXTERN_C
    CCAUXDLL_API
    void
    CCAUXDLL_CALLING_CONV
    CanSetting_release(CANSETTINGHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CanSetting_getBaudrate (CANSETTINGHANDLE, unsigned char net, unsigned short* baudrate);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CanSetting_getFrameType (CANSETTINGHANDLE, unsigned char net, CanFrameType* frameType);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CanSetting_setBaudrate (CANSETTINGHANDLE, unsigned char net, unsigned short baudrate);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CanSetting_setFrameType (CANSETTINGHANDLE, unsigned char net, CanFrameType frameType);

#ifdef __cplusplus
} /* namespace CrossControl */
#endif

#endif /* CC_CAN_SETTING_H */