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 /**   System Management (System)                                          */
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 
30 
31 /**************************************************************************/
32 /*                                                                        */
33 /*  FUNCTION                                               RELEASE        */
34 /*                                                                        */
35 /*    _gx_system_string_get                               PORTABLE C      */
36 /*                                                           6.1          */
37 /*  AUTHOR                                                                */
38 /*                                                                        */
39 /*    Kenneth Maxwell, Microsoft Corporation                              */
40 /*                                                                        */
41 /*  DESCRIPTION                                                           */
42 /*                                                                        */
43 /*    This service gets the string for the specified resource ID.         */
44 /*    This function has been deprecated.                                  */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    string_id                             String resource ID            */
49 /*    return_string                         Pointer to return string      */
50 /*                                            pointer                     */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    status                                Completion status             */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_display_string_get                                              */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    Application Code                                                    */
63 /*    _gx_multi_line_text_view_create       Create multi line text view   */
64 /*                                            widget                      */
65 /*    _gx_multi_line_text_view_text_id_set  Assign text string to the     */
66 /*                                            multi line text view widget */
67 /*    _gx_prompt_text_get                   Get text string for the       */
68 /*                                            prompt widget               */
69 /*    _gx_text_button_text_get              Get text string for the       */
70 /*                                            button widget               */
71 /*    _gx_widget_text_id_draw               Drew the text onto the wdiget */
72 /*                                                                        */
73 /*  RELEASE HISTORY                                                       */
74 /*                                                                        */
75 /*    DATE              NAME                      DESCRIPTION             */
76 /*                                                                        */
77 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
78 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
79 /*                                            resulting in version 6.1    */
80 /*                                                                        */
81 /**************************************************************************/
82 #if defined(GX_ENABLE_DEPRECATED_STRING_API)
_gx_system_string_get(GX_RESOURCE_ID string_id,GX_CONST GX_CHAR ** return_string)83 UINT  _gx_system_string_get(GX_RESOURCE_ID string_id, GX_CONST GX_CHAR **return_string)
84 {
85 UINT status = GX_FAILURE;
86 
87     if (_gx_system_display_created_list)
88     {
89         status = _gx_display_string_get(_gx_system_display_created_list,
90                                         string_id, return_string);
91     }
92     return status;
93 }
94 #endif
95 
96