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 /** Horizontal 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_horizontal_list_selected_widget_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 horizontal list selected get */
42 /* function call. */
43 /* */
44 /* INPUT */
45 /* */
46 /* horizontal_list Horizontal list widget */
47 /* 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_horizontal_list_selected_widget_get Actual horizontal lis */
58 /* selected 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_horizontal_list_selected_widget_get(GX_HORIZONTAL_LIST * horizontal_list,GX_WIDGET ** return_list_entry)73 UINT _gxe_horizontal_list_selected_widget_get(GX_HORIZONTAL_LIST *horizontal_list,
74 GX_WIDGET **return_list_entry)
75 {
76 UINT status;
77
78 /* Check for invalid input pointers. */
79 if ((horizontal_list == GX_NULL) || (return_list_entry == GX_NULL))
80 {
81 return GX_PTR_ERROR;
82 }
83
84 /* Call the actual horizontal list selected get function. */
85 status = _gx_horizontal_list_selected_widget_get(horizontal_list, return_list_entry);
86
87 /* Return completion status. */
88 return status;
89 }
90
91
