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_display.h"
29 
30 /* Bring in externs for caller checking code.  */
31 GX_CALLER_CHECKING_EXTERNS
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _gxe_display_string_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 display_string_get call.         */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    string_id                             String resource ID            */
50 /*    return_string                         Pointer to return string      */
51 /*                                            pointer                     */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_system_string_get                 Actual system string get call */
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 /**************************************************************************/
74 #if defined(GX_ENABLE_DEPRECATED_STRING_API)
_gxe_display_string_get(GX_DISPLAY * display,GX_RESOURCE_ID string_id,GX_CONST GX_CHAR ** return_string)75 UINT  _gxe_display_string_get(GX_DISPLAY *display, GX_RESOURCE_ID string_id, GX_CONST GX_CHAR **return_string)
76 {
77 UINT status;
78 
79     /* Check for invalid caller.  */
80     GX_INIT_AND_THREADS_CALLER_CHECKING
81 
82     /* Check for invalid pointer.  */
83     if (display == GX_NULL || return_string == GX_NULL)
84     {
85         return(GX_PTR_ERROR);
86     }
87 
88     /* Call actual system string get.  */
89     status = _gx_display_string_get(display, string_id, return_string);
90 
91     /* Return status.  */
92     return(status);
93 }
94 #endif
95 
96 /**************************************************************************/
97 /*                                                                        */
98 /*  FUNCTION                                               RELEASE        */
99 /*                                                                        */
100 /*    _gxe_display_string_get_ext                         PORTABLE C      */
101 /*                                                           6.1          */
102 /*  AUTHOR                                                                */
103 /*                                                                        */
104 /*    Kenneth Maxwell, Microsoft Corporation                              */
105 /*                                                                        */
106 /*  DESCRIPTION                                                           */
107 /*                                                                        */
108 /*    This function checks for errors in display_string_get call.         */
109 /*                                                                        */
110 /*  INPUT                                                                 */
111 /*                                                                        */
112 /*    string_id                             String resource ID            */
113 /*    return_string                         Pointer to return string      */
114 /*                                            pointer                     */
115 /*                                                                        */
116 /*  OUTPUT                                                                */
117 /*                                                                        */
118 /*    status                                Completion status             */
119 /*                                                                        */
120 /*  CALLS                                                                 */
121 /*                                                                        */
122 /*    _gx_system_string_get                 Actual system string get call */
123 /*                                                                        */
124 /*  CALLED BY                                                             */
125 /*                                                                        */
126 /*    Application Code                                                    */
127 /*                                                                        */
128 /*  RELEASE HISTORY                                                       */
129 /*                                                                        */
130 /*    DATE              NAME                      DESCRIPTION             */
131 /*                                                                        */
132 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
133 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
134 /*                                            resulting in version 6.1    */
135 /*                                                                        */
136 /**************************************************************************/
_gxe_display_string_get_ext(GX_DISPLAY * display,GX_RESOURCE_ID string_id,GX_STRING * return_string)137 UINT  _gxe_display_string_get_ext(GX_DISPLAY *display, GX_RESOURCE_ID string_id, GX_STRING *return_string)
138 {
139 UINT status;
140 
141     /* Check for invalid caller.  */
142     GX_INIT_AND_THREADS_CALLER_CHECKING
143 
144     /* Check for invalid pointer.  */
145     if (display == GX_NULL || return_string == GX_NULL)
146     {
147         return(GX_PTR_ERROR);
148     }
149 
150     /* Call actual system string get.  */
151     status = _gx_display_string_get_ext(display, string_id, return_string);
152 
153     /* Return status.  */
154     return(status);
155 }
156 
157