CCAux  2.7.2.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.7.2.0, 2014-08-25
8 *
9 * (c) maximatecc 2013
10 *
11 * File description:
12 * Power control access functions
13 *
14 * Use the function GetPower() to get a handle to pass on to the other functions.
15 * Use the method Power_release(POWERHANDLE) to return the handle.
16 *
17 * Example Usage:
18 * @include power_example.cpp
19 *
20 ************************************************/
21 #ifndef CC_POWER_H
22 #define CC_POWER_H
23 
24 #include "CCAuxErrors.h"
25 #include "CCAuxTypes.h"
26 #include "CCPlatform.h"
27 
28 
29 #ifdef __cplusplus
30 namespace CrossControl {
31 #endif
32 
33  typedef void* POWERHANDLE;
34 
35 
49  EXTERN_C
50  CCAUXDLL_API
51  POWERHANDLE
52  CCAUXDLL_CALLING_CONV
53  GetPower(void);
54 
65  EXTERN_C
66  CCAUXDLL_API
67  void
68  CCAUXDLL_CALLING_CONV
69  Power_release(POWERHANDLE);
70 
83  EXTERN_C
84  CCAUXDLL_API
85  eErr
86  CCAUXDLL_CALLING_CONV
87  Power_getBLPowerStatus(POWERHANDLE, CCStatus* status);
88 
98  EXTERN_C
99  CCAUXDLL_API
100  eErr
101  CCAUXDLL_CALLING_CONV
102  Power_getCanPowerStatus(POWERHANDLE, CCStatus* status);
103 
116  EXTERN_C
117  CCAUXDLL_API
118  eErr
119  CCAUXDLL_CALLING_CONV
120  Power_getVideoPowerStatus(POWERHANDLE, unsigned char* videoStatus);
121 
131  EXTERN_C
132  CCAUXDLL_API
133  eErr
134  CCAUXDLL_CALLING_CONV
135  Power_getExtFanPowerStatus(POWERHANDLE, CCStatus* status);
136 
146  EXTERN_C
147  CCAUXDLL_API
148  eErr
149  CCAUXDLL_CALLING_CONV
150  Power_getButtonPowerTransitionStatus(POWERHANDLE, ButtonPowerTransitionStatus* status);
151 
168  EXTERN_C
169  CCAUXDLL_API
170  eErr
171  CCAUXDLL_CALLING_CONV
172  Power_getVideoOCDStatus(POWERHANDLE, OCDStatus* status);
173 
191  EXTERN_C
192  CCAUXDLL_API
193  eErr
194  CCAUXDLL_CALLING_CONV
195  Power_getCanOCDStatus(POWERHANDLE, OCDStatus* status);
196 
209  EXTERN_C
210  CCAUXDLL_API
211  eErr
212  CCAUXDLL_CALLING_CONV
213  Power_setBLPowerStatus(POWERHANDLE, CCStatus status);
214 
224  EXTERN_C
225  CCAUXDLL_API
226  eErr
227  CCAUXDLL_CALLING_CONV
228  Power_setCanPowerStatus(POWERHANDLE, CCStatus status);
229 
243  EXTERN_C
244  CCAUXDLL_API
245  eErr
246  CCAUXDLL_CALLING_CONV
247  Power_setVideoPowerStatus(POWERHANDLE, unsigned char status);
248 
258  EXTERN_C
259  CCAUXDLL_API
260  eErr
261  CCAUXDLL_CALLING_CONV
262  Power_setExtFanPowerStatus(POWERHANDLE, CCStatus status);
263 
275  EXTERN_C
276  CCAUXDLL_API
277  eErr
278  CCAUXDLL_CALLING_CONV
279  Power_ackPowerRequest(POWERHANDLE);
280 
281 #ifdef __cplusplus
282 } /* namespace CrossControl */
283 #endif
284 
285 #endif /* CC_POWER_H */
286 
Generated on Mon Aug 25 2014 17:48:49 for CCAux by   doxygen 1.8.3.1