CCAux  2.15.2.0
CCAux API reference
AuxVersion.h
Go to the documentation of this file.
1 /************************************************
2  *
3  * CROSSCONTROL AUX API
4  *
5  * AuxVersion.h
6  *
7  * Version 2.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
10  *
11 
12  * File description:
13  * Get software versions for firmware and software
14  *
15  * Use the function GetAuxVersion() to get a handle to pass on to the other functions.
16  * Use the method AuxVersion_release(AUXVERSIONHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include auxversion_example.cpp
20  *
21  ************************************************/
22 
23 #ifndef CC_VERSION_H_
24 #define CC_VERSION_H_
25 
26 #include "CCAuxErrors.h"
27 #include "CCPlatform.h"
28 
29 #ifdef __cplusplus
30 namespace CrossControl {
31 #endif
32 
33  typedef void* AUXVERSIONHANDLE;
34 
48  EXTERN_C
49  CCAUXDLL_API
50  AUXVERSIONHANDLE
51  CCAUXDLL_CALLING_CONV
52  GetAuxVersion(void);
53 
64  EXTERN_C
65  CCAUXDLL_API
66  void
67  CCAUXDLL_CALLING_CONV
68  AuxVersion_release(AUXVERSIONHANDLE);
69 
85  EXTERN_C
86  CCAUXDLL_API
87  eErr
88  CCAUXDLL_CALLING_CONV
89  AuxVersion_getFPGAVersion(
90  AUXVERSIONHANDLE,
91  uint8_t* major,
92  uint8_t* minor,
93  uint8_t* release,
94  uint8_t* build);
95 
111  EXTERN_C
112  CCAUXDLL_API
113  eErr
114  CCAUXDLL_CALLING_CONV
115  AuxVersion_getSSVersion(
116  AUXVERSIONHANDLE,
117  uint8_t* major,
118  uint8_t* minor,
119  uint8_t* release,
120  uint8_t* build);
121 
137  EXTERN_C
138  CCAUXDLL_API
139  eErr
140  CCAUXDLL_CALLING_CONV
141  AuxVersion_getFrontVersion(
142  AUXVERSIONHANDLE,
143  uint8_t* major,
144  uint8_t* minor,
145  uint8_t* release,
146  uint8_t* build);
147 
165  EXTERN_C
166  CCAUXDLL_API
167  eErr
168  CCAUXDLL_CALLING_CONV
169  AuxVersion_getCCAuxVersion(
170  AUXVERSIONHANDLE,
171  uint8_t* major,
172  uint8_t* minor,
173  uint8_t* release,
174  uint8_t* build);
175 
191  EXTERN_C
192  CCAUXDLL_API
193  eErr
194  CCAUXDLL_CALLING_CONV
195  AuxVersion_getOSVersion(
196  AUXVERSIONHANDLE,
197  uint8_t* major,
198  uint8_t* minor,
199  uint8_t* release,
200  uint8_t* build);
201 
218  EXTERN_C
219  CCAUXDLL_API
220  eErr
221  CCAUXDLL_CALLING_CONV
222  AuxVersion_getCCAuxDrvVersion(
223  AUXVERSIONHANDLE,
224  uint8_t* major,
225  uint8_t* minor,
226  uint8_t* release,
227  uint8_t* build);
228 
229 #ifdef __cplusplus
230 } /* namespace CrossControl */
231 #endif
232 
233 #endif /* CC_VERSION_H_ */
234 
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CCPlatform.h
CrossControl::GetAuxVersion
EXTERN_C CCAUXDLL_API AUXVERSIONHANDLE CCAUXDLL_CALLING_CONV GetAuxVersion(void)
CrossControl::AuxVersion_getCCAuxDrvVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxDrvVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CrossControl
Definition: About.h:30
CrossControl::AuxVersion_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV AuxVersion_release(AUXVERSIONHANDLE)
CrossControl::AuxVersion_getSSVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getSSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
CrossControl::AuxVersion_getFrontVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFrontVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CrossControl::AuxVersion_getCCAuxVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CCAuxErrors.h
CrossControl::AuxVersion_getOSVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getOSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CrossControl::AuxVersion_getFPGAVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFPGAVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CrossControl::AUXVERSIONHANDLE
void * AUXVERSIONHANDLE
Definition: AuxVersion.h:33
Generated on Wed Jul 8 2020 12:44:31 for CCAux by   doxygen 1.8.14