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 /** Button Management (Button) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_button.h"
28
29 GX_CALLER_CHECKING_EXTERNS
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _gxe_button_event_process PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Kenneth Maxwell, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function checks for errors in the button event process */
44 /* function call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* button Pointer to button control */
49 /* block */
50 /* event_ptr Incoming event to process */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_button_event_process Actual button event process */
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_button_event_process(GX_BUTTON * button,GX_EVENT * event_ptr)74 UINT _gxe_button_event_process(GX_BUTTON *button, GX_EVENT *event_ptr)
75 {
76 UINT status;
77
78 /* Check for appropriate caller. */
79 GX_INIT_AND_THREADS_CALLER_CHECKING
80
81 /* Check for invalid input pointers. */
82 if ((button == GX_NULL) || (event_ptr == GX_NULL))
83 {
84 return(GX_PTR_ERROR);
85 }
86
87 /* Call the actual button event process function. */
88 status = _gx_button_event_process(button, event_ptr);
89
90 /* Return completion status. */
91 return status;
92 }
93
94
