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 /**   Single Line Text Input Management (Single Line Text)                */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_multi_line_text_input.h"
28 
29 /**************************************************************************/
30 /*                                                                        */
31 /*  FUNCTION                                               RELEASE        */
32 /*                                                                        */
33 /*    _gxe_multi_line_text_input_buffer_get               PORTABLE C      */
34 /*                                                           6.1          */
35 /*  AUTHOR                                                                */
36 /*                                                                        */
37 /*    Kenneth Maxwell, Microsoft Corporation                              */
38 /*                                                                        */
39 /*  DESCRIPTION                                                           */
40 /*                                                                        */
41 /*    This function checks for errors in the multi line text input        */
42 /*      buffer get call.                                                  */
43 /*                                                                        */
44 /*  INPUT                                                                 */
45 /*                                                                        */
46 /*    text_input_ptr                        multi line text input         */
47 /*                                            control blcok               */
48 /*    buffer_address                        The address of the input      */
49 /*                                            buffer                      */
50 /*    content_size                          The count of the input data   */
51 /*    buffer_size                           The size of the input buffer. */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_multi_line_text_input_buffer_get                                */
60 /*                                          Actual multi line text input  */
61 /*                                            buffer get call             */
62 /*                                                                        */
63 /*  CALLED BY                                                             */
64 /*                                                                        */
65 /*    Application Code                                                    */
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 /**************************************************************************/
76 
_gxe_multi_line_text_input_buffer_get(GX_MULTI_LINE_TEXT_INPUT * text_input_ptr,GX_CHAR ** buffer_address,UINT * content_size,UINT * buffer_size)77 UINT _gxe_multi_line_text_input_buffer_get(GX_MULTI_LINE_TEXT_INPUT *text_input_ptr, GX_CHAR **buffer_address,
78                                            UINT *content_size, UINT *buffer_size)
79 {
80 UINT status;
81 
82     /* Check for invalid input pointers.  */
83     if (text_input_ptr == GX_NULL)
84     {
85         return(GX_PTR_ERROR);
86     }
87 
88     /* Call actual single line text input buffer clear function.  */
89     status = _gx_multi_line_text_input_buffer_get(text_input_ptr, buffer_address, content_size, buffer_size);
90 
91     return status;
92 }
93 
94