CCAux  2.15.2.0
CCAux API reference
CanSetting.h
Go to the documentation of this file.
1 /************************************************
2  *
3  * CROSSCONTROL AUX API
4  *
5  * CanSetting.h
6  *
7  * Version 2.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
10  *
11 
12  * File description:
13  * Can settings
14  *
15  * Use the function GetCanSetting() to get a handle to pass on to the other functions.
16  * Use the method CanSetting_release(CANSETTINGHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include cansetting_example.cpp
20  *
21  ************************************************/
22 #ifndef CC_CAN_SETTING_H
23 #define CC_CAN_SETTING_H
24 
25 #include "CCAuxErrors.h"
26 #include "CCPlatform.h"
27 
28 #ifdef __cplusplus
29 namespace CrossControl {
30 #endif
31 
32  typedef void* CANSETTINGHANDLE;
33 
47  EXTERN_C
48  CCAUXDLL_API
50  CCAUXDLL_CALLING_CONV
51  GetCanSetting(void);
52 
63  EXTERN_C
64  CCAUXDLL_API
65  void
66  CCAUXDLL_CALLING_CONV
68 
82  EXTERN_C
83  CCAUXDLL_API
84  eErr
85  CCAUXDLL_CALLING_CONV
87 
101  EXTERN_C
102  CCAUXDLL_API
103  eErr
104  CCAUXDLL_CALLING_CONV
106 
119  EXTERN_C
120  CCAUXDLL_API
121  eErr
122  CCAUXDLL_CALLING_CONV
124 
135  EXTERN_C
136  CCAUXDLL_API
137  eErr
138  CCAUXDLL_CALLING_CONV
140 
141 #ifdef __cplusplus
142 } /* namespace CrossControl */
143 #endif
144 
145 #endif /* CC_CAN_SETTING_H */
146 
eErr
Definition: CCAuxTypes.h:159
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_setBaudrate(CANSETTINGHANDLE, uint8_t net, uint16_t baudrate)
Definition: About.h:30
void * CANSETTINGHANDLE
Definition: CanSetting.h:32
unsigned short uint16_t
Definition: CCAuxTypes.h:48
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CanSetting_release(CANSETTINGHANDLE)
unsigned char uint8_t
Definition: CCAuxTypes.h:47
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_setFrameType(CANSETTINGHANDLE, uint8_t net, CanFrameType frameType)
CanFrameType
Definition: CCAuxTypes.h:305
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_getFrameType(CANSETTINGHANDLE, uint8_t net, CanFrameType *frameType)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_getBaudrate(CANSETTINGHANDLE, uint8_t net, uint16_t *baudrate)
EXTERN_C CCAUXDLL_API CANSETTINGHANDLE CCAUXDLL_CALLING_CONV GetCanSetting(void)