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_previous_sibling_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 */
42 /* gx_widget_previous_sibling_get 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_previous_sibling_get Actual */
58 /* widget_previous_sibling_get */
59 /* function. */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
70 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_gxe_widget_previous_sibling_get(GX_WIDGET * current,GX_WIDGET ** return_widget)74 UINT _gxe_widget_previous_sibling_get(GX_WIDGET *current, GX_WIDGET **return_widget)
75 {
76 UINT status;
77
78 /* Check for invalid input pointers. */
79 if ((current == GX_NULL) || (return_widget == GX_NULL))
80 {
81 return(GX_PTR_ERROR);
82 }
83
84 /* Check for invalid widget. */
85 if (current -> gx_widget_type == 0)
86 {
87 return(GX_INVALID_WIDGET);
88 }
89
90 /* Call actual widget find function. */
91 status = _gx_widget_previous_sibling_get(current, return_widget);
92
93 /* Return successful completion. */
94 return(status);
95 }
96
97
