1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** GUIX Component */
17 /** */
18 /** System Management (System) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_system.h"
29
30 /**************************************************************************/
31 /* */
32 /* FUNCTION RELEASE */
33 /* */
34 /* _gxe_system_widget_find PORTABLE C */
35 /* 6.1 */
36 /* AUTHOR */
37 /* */
38 /* Kenneth Maxwell, Microsoft Corporation */
39 /* */
40 /* DESCRIPTION */
41 /* */
42 /* This function checks for errors in system widget search call. */
43 /* */
44 /* INPUT */
45 /* */
46 /* widget_id Widget ID to search for */
47 /* search_level Specifies the depth of the */
48 /* search */
49 /* return_search_result Pointer to destination for */
50 /* widget found */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_system_widget_find Actual widget find function */
59 /* */
60 /* CALLED BY */
61 /* */
62 /* GUIX 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_system_widget_find(USHORT widget_id,INT search_level,GX_WIDGET ** return_search_result)73 UINT _gxe_system_widget_find(USHORT widget_id, INT search_level, GX_WIDGET **return_search_result)
74 {
75 UINT status;
76
77 /* Check for invalid pointer. */
78 if (return_search_result == GX_NULL)
79 {
80 return(GX_PTR_ERROR);
81 }
82
83 /* Call actual system widget search. */
84 status = _gx_system_widget_find(widget_id, search_level, return_search_result);
85
86 /* Return status. */
87 return status;
88 }
89
90
