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 /** Vertical List (List) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_window.h"
28
29 GX_CALLER_CHECKING_EXTERNS
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _gxe_vertical_list_selected_set PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Kenneth Maxwell, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function checks for errors in the vertical list selected set */
44 /* function call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* vertical_list Vertical list control block */
49 /* list_entry Pointer to new list entry */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* status Completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _gx_vertical_list_selected_set Actual vertical list selected */
58 /* set 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_set(GX_VERTICAL_LIST * vertical_list,INT index)73 UINT _gxe_vertical_list_selected_set(GX_VERTICAL_LIST *vertical_list, INT index)
74 {
75 UINT status;
76
77 /* Check for appropriate caller. */
78 GX_INIT_AND_THREADS_CALLER_CHECKING
79
80 /* Check for invalid input pointers. */
81 if (vertical_list == GX_NULL)
82 {
83 return GX_PTR_ERROR;
84 }
85
86 /* Check for invalid widget. */
87 if (vertical_list -> gx_widget_type == 0)
88 {
89 return GX_INVALID_WIDGET;
90 }
91
92 /* Call the actual vertical list selected set function. */
93 status = _gx_vertical_list_selected_set(vertical_list, index);
94
95 /* Return completion status. */
96 return status;
97 }
98
99
