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 /** Text 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_system.h"
28 #include "gx_display.h"
29 #include "gx_button.h"
30
31 /* Bring in externs for caller checking code. */
32 GX_CALLER_CHECKING_EXTERNS
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _gxe_text_button_text_get PORTABLE C */
38 /* 6.1 */
39 /* AUTHOR */
40 /* */
41 /* Kenneth Maxwell, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function checks for errors in the text button text get */
46 /* function call. */
47 /* */
48 /* */
49 /* INPUT */
50 /* */
51 /* button Button control block */
52 /* return_text String used in the button */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* _gx_text_button_text_get Actual button text get call */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
71 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
75 #if defined(GX_ENABLE_DEPRECATED_STRING_API)
_gxe_text_button_text_get(GX_TEXT_BUTTON * button,GX_CONST GX_CHAR ** return_text)76 UINT _gxe_text_button_text_get(GX_TEXT_BUTTON *button, GX_CONST GX_CHAR **return_text)
77 {
78 UINT status;
79
80 /* Check for appropriate caller. */
81 GX_INIT_AND_THREADS_CALLER_CHECKING
82
83 /* Check for invalid input pointers. */
84 if ((button == GX_NULL) || (return_text == GX_NULL))
85 {
86 return(GX_PTR_ERROR);
87 }
88
89 /* Check for invalid widget. */
90 if (button -> gx_widget_type == 0)
91 {
92 return(GX_INVALID_WIDGET);
93 }
94
95 /* Call the actual text button create function. */
96 status = _gx_text_button_text_get(button, return_text);
97
98 /* Return completion status. */
99 return status;
100 }
101 #endif
102
103 /**************************************************************************/
104 /* */
105 /* FUNCTION RELEASE */
106 /* */
107 /* _gxe_text_button_text_get_ext PORTABLE C */
108 /* 6.1 */
109 /* AUTHOR */
110 /* */
111 /* Kenneth Maxwell, Microsoft Corporation */
112 /* */
113 /* DESCRIPTION */
114 /* */
115 /* This function checks for errors in the text button text get */
116 /* function call. */
117 /* */
118 /* */
119 /* INPUT */
120 /* */
121 /* button Button control block */
122 /* return_text String used in the button */
123 /* */
124 /* OUTPUT */
125 /* */
126 /* status Completion status */
127 /* */
128 /* CALLS */
129 /* */
130 /* _gx_text_button_text_get_ext Actual button text get call */
131 /* */
132 /* CALLED BY */
133 /* */
134 /* Application Code */
135 /* */
136 /* RELEASE HISTORY */
137 /* */
138 /* DATE NAME DESCRIPTION */
139 /* */
140 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
141 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
142 /* resulting in version 6.1 */
143 /* */
144 /**************************************************************************/
_gxe_text_button_text_get_ext(GX_TEXT_BUTTON * button,GX_STRING * return_text)145 UINT _gxe_text_button_text_get_ext(GX_TEXT_BUTTON *button, GX_STRING *return_text)
146 {
147 UINT status;
148
149 /* Check for appropriate caller. */
150 GX_INIT_AND_THREADS_CALLER_CHECKING
151
152 /* Check for invalid input pointers. */
153 if ((button == GX_NULL) || (return_text == GX_NULL))
154 {
155 return(GX_PTR_ERROR);
156 }
157
158 /* Check for invalid widget. */
159 if (button -> gx_widget_type == 0)
160 {
161 return(GX_INVALID_WIDGET);
162 }
163
164 /* Call the actual text button create function. */
165 status = _gx_text_button_text_get_ext(button, return_text);
166
167 /* Return completion status. */
168 return status;
169 }
170
171
