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 /** Prompt Management (Prompt) */
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 #include "gx_prompt.h"
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _gxe_prompt_text_get PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Kenneth Maxwell, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function checks errors in the prompt text get function. */
44 /* */
45 /* */
46 /* INPUT */
47 /* */
48 /* prompt Pointer to prompt widget */
49 /* control block */
50 /* return_text Pointer to destination for text */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_prompt_text_get The actual function */
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 /**************************************************************************/
73 #if defined(GX_ENABLE_DEPRECATED_STRING_API)
_gxe_prompt_text_get(GX_PROMPT * prompt,GX_CONST GX_CHAR ** return_text)74 UINT _gxe_prompt_text_get(GX_PROMPT *prompt, GX_CONST GX_CHAR **return_text)
75 {
76 UINT status;
77
78 /* Check error for valid pointer. */
79 if (prompt == GX_NULL)
80 {
81 return(GX_PTR_ERROR);
82 }
83
84 /* Check for invalid widget. */
85 if (prompt -> gx_widget_type == 0)
86 {
87 return(GX_INVALID_WIDGET);
88 }
89
90 /* Call the actual function. */
91 status = _gx_prompt_text_get(prompt, return_text);
92
93 /* Return completion status. */
94 return(status);
95 }
96 #endif
97
98 /**************************************************************************/
99 /* */
100 /* FUNCTION RELEASE */
101 /* */
102 /* _gxe_prompt_text_get_ext PORTABLE C */
103 /* 6.1 */
104 /* AUTHOR */
105 /* */
106 /* Kenneth Maxwell, Microsoft Corporation */
107 /* */
108 /* DESCRIPTION */
109 /* */
110 /* This function checks errors in the prompt text get function. */
111 /* */
112 /* */
113 /* INPUT */
114 /* */
115 /* prompt Pointer to prompt widget */
116 /* control block */
117 /* return_text Pointer to destination for text */
118 /* */
119 /* OUTPUT */
120 /* */
121 /* status Completion status */
122 /* */
123 /* CALLS */
124 /* */
125 /* _gx_prompt_text_get_ext The actual function */
126 /* */
127 /* CALLED BY */
128 /* */
129 /* Application Code */
130 /* */
131 /* RELEASE HISTORY */
132 /* */
133 /* DATE NAME DESCRIPTION */
134 /* */
135 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
136 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
137 /* resulting in version 6.1 */
138 /* */
139 /**************************************************************************/
_gxe_prompt_text_get_ext(GX_PROMPT * prompt,GX_STRING * return_text)140 UINT _gxe_prompt_text_get_ext(GX_PROMPT *prompt, GX_STRING *return_text)
141 {
142 UINT status;
143
144 /* Check error for valid pointer. */
145 if (prompt == GX_NULL)
146 {
147 return(GX_PTR_ERROR);
148 }
149
150 /* Check for invalid widget. */
151 if (prompt -> gx_widget_type == 0)
152 {
153 return(GX_INVALID_WIDGET);
154 }
155
156 /* Call the actual function. */
157 status = _gx_prompt_text_get_ext(prompt, return_text);
158
159 /* Return completion status. */
160 return(status);
161 }
162
163