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 /** Vertical List (List) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_window.h"
29
30 /**************************************************************************/
31 /* */
32 /* FUNCTION RELEASE */
33 /* */
34 /* _gxe_vertical_list_selected_widget_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 the vertical list selected get */
43 /* function call. */
44 /* */
45 /* INPUT */
46 /* */
47 /* vertical_list Vertical list control block */
48 /* return_list_entry Destination for return list */
49 /* entry widget */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* status Completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _gx_vertical_list_selected_get Actual vertical list selected */
58 /* get function */
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_vertical_list_selected_widget_get(GX_VERTICAL_LIST * vertical_list,GX_WIDGET ** return_list_entry)73 UINT _gxe_vertical_list_selected_widget_get(GX_VERTICAL_LIST *vertical_list,
74 GX_WIDGET **return_list_entry)
75 {
76 UINT status;
77
78 /* Check for invalid input pointers. */
79 if ((vertical_list == GX_NULL) || (return_list_entry == GX_NULL))
80 {
81 return GX_PTR_ERROR;
82 }
83
84 /* Check for invalid widget. */
85 if (vertical_list -> gx_widget_type == 0)
86 {
87 return GX_INVALID_WIDGET;
88 }
89
90 /* Call the actual vertical list selected get function. */
91 status = _gx_vertical_list_selected_widget_get(vertical_list, return_list_entry);
92
93 /* Return completion status. */
94 return status;
95 }
96
97
