CCAux  2.8.3.0
CCAux API reference
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator
Power.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * Power.h
6 *
7 * Version 2.8.3.0, 2016-04-06
8 *
9 * (c) maximatecc 2013
10 *
11 
12  * File description:
13  * Power control access functions
14  *
15  * Use the function GetPower() to get a handle to pass on to the other functions.
16  * Use the method Power_release(POWERHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include power_example.cpp
20  *
21  ************************************************/
22 #ifndef CC_POWER_H
23 #define CC_POWER_H
24 
25 #include "CCAuxErrors.h"
26 #include "CCAuxTypes.h"
27 #include "CCPlatform.h"
28 
29 #ifdef __cplusplus
30 namespace CrossControl {
31 #endif
32 
33  typedef void* POWERHANDLE;
34 
48  EXTERN_C
49  CCAUXDLL_API
50  POWERHANDLE
51  CCAUXDLL_CALLING_CONV
52  GetPower(void);
53 
64  EXTERN_C
65  CCAUXDLL_API
66  void
67  CCAUXDLL_CALLING_CONV
68  Power_release(POWERHANDLE);
69 
82  EXTERN_C
83  CCAUXDLL_API
84  eErr
85  CCAUXDLL_CALLING_CONV
86  Power_getBLPowerStatus(POWERHANDLE, CCStatus* status);
87 
97  EXTERN_C
98  CCAUXDLL_API
99  eErr
100  CCAUXDLL_CALLING_CONV
101  Power_getCanPowerStatus(POWERHANDLE, CCStatus* status);
102 
115  EXTERN_C
116  CCAUXDLL_API
117  eErr
118  CCAUXDLL_CALLING_CONV
119  Power_getVideoPowerStatus(POWERHANDLE, unsigned char* videoStatus);
120 
130  EXTERN_C
131  CCAUXDLL_API
132  eErr
133  CCAUXDLL_CALLING_CONV
134  Power_getExtFanPowerStatus(POWERHANDLE, CCStatus* status);
135 
145  EXTERN_C
146  CCAUXDLL_API
147  eErr
148  CCAUXDLL_CALLING_CONV
149  Power_getButtonPowerTransitionStatus(POWERHANDLE, ButtonPowerTransitionStatus* status);
150 
167  EXTERN_C
168  CCAUXDLL_API
169  eErr
170  CCAUXDLL_CALLING_CONV
171  Power_getVideoOCDStatus(POWERHANDLE, OCDStatus* status);
172 
190  EXTERN_C
191  CCAUXDLL_API
192  eErr
193  CCAUXDLL_CALLING_CONV
194  Power_getCanOCDStatus(POWERHANDLE, OCDStatus* status);
195 
208  EXTERN_C
209  CCAUXDLL_API
210  eErr
211  CCAUXDLL_CALLING_CONV
212  Power_setBLPowerStatus(POWERHANDLE, CCStatus status);
213 
223  EXTERN_C
224  CCAUXDLL_API
225  eErr
226  CCAUXDLL_CALLING_CONV
227  Power_setCanPowerStatus(POWERHANDLE, CCStatus status);
228 
242  EXTERN_C
243  CCAUXDLL_API
244  eErr
245  CCAUXDLL_CALLING_CONV
246  Power_setVideoPowerStatus(POWERHANDLE, unsigned char status);
247 
257  EXTERN_C
258  CCAUXDLL_API
259  eErr
260  CCAUXDLL_CALLING_CONV
261  Power_setExtFanPowerStatus(POWERHANDLE, CCStatus status);
262 
274  EXTERN_C
275  CCAUXDLL_API
276  eErr
277  CCAUXDLL_CALLING_CONV
278  Power_ackPowerRequest(POWERHANDLE);
279 
280 #ifdef __cplusplus
281 } /* namespace CrossControl */
282 #endif
283 
284 #endif /* CC_POWER_H */
285 
Generated on Wed Apr 6 2016 19:46:22 for CCAux by   doxygen 1.8.3.1