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 /** System Management (System) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_system.h"
28
29 /**************************************************************************/
30 /* */
31 /* FUNCTION RELEASE */
32 /* */
33 /* _gxe_system_widget_find PORTABLE C */
34 /* 6.1 */
35 /* AUTHOR */
36 /* */
37 /* Kenneth Maxwell, Microsoft Corporation */
38 /* */
39 /* DESCRIPTION */
40 /* */
41 /* This function checks for errors in system widget search call. */
42 /* */
43 /* INPUT */
44 /* */
45 /* widget_id Widget ID to search for */
46 /* search_level Specifies the depth of the */
47 /* search */
48 /* return_search_result Pointer to destination for */
49 /* widget found */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* status Completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _gx_system_widget_find Actual widget find function */
58 /* */
59 /* CALLED BY */
60 /* */
61 /* GUIX 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_system_widget_find(USHORT widget_id,INT search_level,GX_WIDGET ** return_search_result)72 UINT _gxe_system_widget_find(USHORT widget_id, INT search_level, GX_WIDGET **return_search_result)
73 {
74 UINT status;
75
76 /* Check for invalid pointer. */
77 if (return_search_result == GX_NULL)
78 {
79 return(GX_PTR_ERROR);
80 }
81
82 /* Call actual system widget search. */
83 status = _gx_system_widget_find(widget_id, search_level, return_search_result);
84
85 /* Return status. */
86 return status;
87 }
88
89
