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 /** Horizontal 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_horizontal_list_selected_index_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 horizontal list selected get */
43 /* function call. */
44 /* */
45 /* INPUT */
46 /* */
47 /* horizontal_list Horizontal list widget */
48 /* control block */
49 /* return_list_entry Destination for return list */
50 /* entry widget */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_horizontal_list_selected_index_get Actual horizontal lis */
59 /* selected get function */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
70 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_gxe_horizontal_list_selected_index_get(GX_HORIZONTAL_LIST * horizontal_list,INT * return_index)74 UINT _gxe_horizontal_list_selected_index_get(GX_HORIZONTAL_LIST *horizontal_list,
75 INT *return_index)
76 {
77 UINT status;
78
79 /* Check for invalid input pointers. */
80 if ((horizontal_list == GX_NULL) || (return_index == GX_NULL))
81 {
82 return GX_PTR_ERROR;
83 }
84
85 /* Call the actual horizontal list selected get function. */
86 status = _gx_horizontal_list_selected_index_get(horizontal_list, return_index);
87
88 /* Return completion status. */
89 return status;
90 }
91
92
