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