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 /** Menu Management (Menu) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_menu.h"
28
29 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_menu_remove PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks for errors in menu remove function call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* menu Pointer to the menu control */
49 /* block */
50 /* widget Widget to remove */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_menu_remove Actual menu remove call */
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_menu_remove(GX_MENU * menu,GX_WIDGET * widget)73 UINT _gxe_menu_remove(GX_MENU *menu, GX_WIDGET *widget)
74 {
75 UINT status;
76
77 /* Check for appropriate caller. */
78 GX_INIT_AND_THREADS_CALLER_CHECKING
79
80 /* Check for invalid input pointers. */
81 if ((!menu) || (!widget))
82 {
83 return(GX_PTR_ERROR);
84 }
85
86 /* Call actual menu remove function. */
87 status = _gx_menu_remove(menu, widget);
88
89 return(status);
90 }
91
92
