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 /**************************************************************************/
30 /* */
31 /* FUNCTION RELEASE */
32 /* */
33 /* _gxe_vertical_list_selected_index_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 the vertical list selected get */
42 /* function call. */
43 /* */
44 /* INPUT */
45 /* */
46 /* vertical_list Vertical list control block */
47 /* return_list_entry Destination for return list */
48 /* entry widget */
49 /* */
50 /* OUTPUT */
51 /* */
52 /* status Completion status */
53 /* */
54 /* CALLS */
55 /* */
56 /* _gx_vertical_list_selected_get Actual vertical list selected */
57 /* get function */
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_vertical_list_selected_index_get(GX_VERTICAL_LIST * vertical_list,INT * return_index)72 UINT _gxe_vertical_list_selected_index_get(GX_VERTICAL_LIST *vertical_list,
73 INT *return_index)
74 {
75 UINT status;
76
77 /* Check for invalid input pointers. */
78 if ((vertical_list == GX_NULL) || (return_index == GX_NULL))
79 {
80 return GX_PTR_ERROR;
81 }
82
83 /* Check for invalid widget. */
84 if (vertical_list -> gx_widget_type == 0)
85 {
86 return GX_INVALID_WIDGET;
87 }
88
89 /* Call the actual vertical list selected get function. */
90 status = _gx_vertical_list_selected_index_get(vertical_list, return_index);
91
92 /* Return completion status. */
93 return status;
94 }
95
96
