1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** GUIX Component */
17 /** */
18 /** Circular Gauge Management (Circular Gauge) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_circular_gauge.h"
29
30 /**************************************************************************/
31 /* */
32 /* FUNCTION RELEASE */
33 /* */
34 /* _gxe_circular_gauge_angle_get PORTABLE C */
35 /* 6.1 */
36 /* AUTHOR */
37 /* */
38 /* Kenneth Maxwell, Microsoft Corporation */
39 /* */
40 /* DESCRIPTION */
41 /* */
42 /* This function checks for errors in circular gauge angle range get */
43 /* call. */
44 /* */
45 /* INPUT */
46 /* */
47 /* circular_gauge Circular gauge control block */
48 /* start_angle Retrieved current angle. */
49 /* target_angle Retrieved target angle. */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* status Completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _gx_circular_gauge_angle_get Actual circular gauge angle */
58 /* get call. */
59 /* */
60 /* CALLED BY */
61 /* */
62 /* Application Code */
63 /* */
64 /* RELEASE HISTORY */
65 /* */
66 /* DATE NAME DESCRIPTION */
67 /* */
68 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
69 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
70 /* resulting in version 6.1 */
71 /* */
72 /**************************************************************************/
_gxe_circular_gauge_angle_get(GX_CIRCULAR_GAUGE * circular_gauge,INT * angle)73 UINT _gxe_circular_gauge_angle_get(GX_CIRCULAR_GAUGE *circular_gauge, INT *angle)
74 {
75 UINT status;
76
77 /* Check for invalid input pointers. */
78 if (circular_gauge == GX_NULL || angle == GX_NULL)
79 {
80 return GX_PTR_ERROR;
81 }
82
83 /* Call the actual gauge angle get function. */
84 status = _gx_circular_gauge_angle_get(circular_gauge, angle);
85
86 return status;
87 }
88
89
