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 /** Widget Management (Widget) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_widget.h"
28
29 /**************************************************************************/
30 /* */
31 /* FUNCTION RELEASE */
32 /* */
33 /* _gxe_widget_parent_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 gx_widget_parent_get */
42 /* function call. */
43 /* */
44 /* INPUT */
45 /* */
46 /* current Pointer to current widget to */
47 /* start search from */
48 /* return_widget Pointer to destination for */
49 /* found widget */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* status Completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _gx_widget_parent_get Actual widget_parent_get */
58 /* 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_widget_parent_get(GX_WIDGET * current,GX_WIDGET ** return_widget)73 UINT _gxe_widget_parent_get(GX_WIDGET *current, GX_WIDGET **return_widget)
74 {
75 UINT status;
76
77 /* Check for invalid input pointers. */
78 if ((current == GX_NULL) || (return_widget == GX_NULL))
79 {
80 return(GX_PTR_ERROR);
81 }
82
83 /* Check for invalid widget. */
84 if (current -> gx_widget_type == 0)
85 {
86 return(GX_INVALID_WIDGET);
87 }
88
89 /* Call actual widget find function. */
90 status = _gx_widget_parent_get(current, return_widget);
91
92 /* Return successful completion. */
93 return(status);
94 }
95
96
