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 /* Bring in externs for caller checking code.  */
33 GX_CALLER_CHECKING_EXTERNS
34 /**************************************************************************/
35 /*                                                                        */
36 /*  FUNCTION                                               RELEASE        */
37 /*                                                                        */
38 /*    _gxe_prompt_text_id_set                             PORTABLE C      */
39 /*                                                           6.1          */
40 /*  AUTHOR                                                                */
41 /*                                                                        */
42 /*    Kenneth Maxwell, Microsoft Corporation                              */
43 /*                                                                        */
44 /*  DESCRIPTION                                                           */
45 /*                                                                        */
46 /*    This function checks for errors in the orinot text id set function  */
47 /*    call.                                                               */
48 /*                                                                        */
49 /*                                                                        */
50 /*  INPUT                                                                 */
51 /*                                                                        */
52 /*    prompt                                Prompt control block          */
53 /*    string_id                             Resource ID of the string     */
54 /*                                                                        */
55 /*  OUTPUT                                                                */
56 /*                                                                        */
57 /*    status                                Completion status             */
58 /*                                                                        */
59 /*  CALLS                                                                 */
60 /*                                                                        */
61 /*    _gx_prompt_text_id_set                Actual prompt text id set     */
62 /*                                            function                    */
63 /*                                                                        */
64 /*  CALLED BY                                                             */
65 /*                                                                        */
66 /*    Application Cdoe                                                    */
67 /*                                                                        */
68 /*  RELEASE HISTORY                                                       */
69 /*                                                                        */
70 /*    DATE              NAME                      DESCRIPTION             */
71 /*                                                                        */
72 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
73 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
74 /*                                            resulting in version 6.1    */
75 /*                                                                        */
76 /**************************************************************************/
_gxe_prompt_text_id_set(GX_PROMPT * prompt,GX_RESOURCE_ID string_id)77 UINT  _gxe_prompt_text_id_set(GX_PROMPT *prompt, GX_RESOURCE_ID string_id)
78 {
79 UINT status;
80 
81     /* Check for invalid caller.  */
82     GX_INIT_AND_THREADS_CALLER_CHECKING
83 
84     if (!prompt)
85     {
86         return(GX_PTR_ERROR);
87     }
88 
89     if (prompt -> gx_prompt_string.gx_string_ptr && (prompt -> gx_widget_style & GX_STYLE_TEXT_COPY))
90     {
91         if (_gx_system_memory_free == GX_NULL)
92         {
93             return GX_SYSTEM_MEMORY_ERROR;
94         }
95     }
96 
97     /* Call the actual function.  */
98     status = _gx_prompt_text_id_set(prompt, string_id);
99 
100     /* Return completion status.  */
101     return(status);
102 }
103 
104