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 /** Tree View Management (Tree View) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_tree_view.h"
28
29 /**************************************************************************/
30 /* */
31 /* FUNCTION RELEASE */
32 /* */
33 /* _gxe_tree_view_selected_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 tree view selected get function */
42 /* call. */
43 /* */
44 /* INPUT */
45 /* */
46 /* tree Pointer to the tree view */
47 /* control block */
48 /* selected Selected widget to return */
49 /* */
50 /* OUTPUT */
51 /* */
52 /* status Completion status */
53 /* */
54 /* CALLS */
55 /* */
56 /* _gx_tree_view_selected_get Actual tree view selected get */
57 /* function call */
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_tree_view_selected_get(GX_TREE_VIEW * tree,GX_WIDGET ** selected)72 UINT _gxe_tree_view_selected_get(GX_TREE_VIEW *tree, GX_WIDGET **selected)
73 {
74 UINT status;
75
76 /* Check for invalid input pointers. */
77 if ((!tree) || (!selected))
78 {
79 return(GX_PTR_ERROR);
80 }
81
82 /* Check for invalid widget. */
83 if (tree -> gx_widget_type == 0)
84 {
85 return(GX_INVALID_WIDGET);
86 }
87
88 /* Call actual tree view seleced get function. */
89 status = _gx_tree_view_selected_get(tree, selected);
90
91 return(status);
92 }
93
94
