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 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_horizontal_list_selected_set PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks for errors in the horizontal list selected set */
45 /* function call. */
46 /* */
47 /* INPUT */
48 /* */
49 /* horizontal_list Horizontal list widget */
50 /* control block */
51 /* list_entry Pointer to new list entry */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* status Completion status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _gx_horizontal_list_selected_set Actual horizontal list */
60 /* seelcted set function */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
71 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_gxe_horizontal_list_selected_set(GX_HORIZONTAL_LIST * horizontal_list,INT index)75 UINT _gxe_horizontal_list_selected_set(GX_HORIZONTAL_LIST *horizontal_list, INT index)
76 {
77 UINT status;
78
79 /* Check for appropriate caller. */
80 GX_INIT_AND_THREADS_CALLER_CHECKING
81
82 /* Check for invalid input pointers. */
83 if (horizontal_list == GX_NULL)
84 {
85 return GX_PTR_ERROR;
86 }
87
88 /* Check for valid parent size. */
89 if (horizontal_list -> gx_widget_type == 0)
90 {
91 return GX_INVALID_WIDGET;
92 }
93
94 /* Call the actual horizontal list selected set function. */
95 status = _gx_horizontal_list_selected_set(horizontal_list, index);
96
97 /* Return completion status. */
98 return status;
99 }
100
101
