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