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 /** Multi Line Text Input Management (Multi 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 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_multi_line_text_input_buffer_clear PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks for errors in the multi line text input buffer */
45 /* clear call. */
46 /* */
47 /* INPUT */
48 /* */
49 /* text_input_ptr Multi Line input control block*/
50 /* */
51 /* OUTPUT */
52 /* */
53 /* status Completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _gx_multi_line_text_input_buffer_clear */
58 /* Actual multi line text input */
59 /* buffer clear 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
_gxe_multi_line_text_input_buffer_clear(GX_MULTI_LINE_TEXT_INPUT * text_input_ptr)75 UINT _gxe_multi_line_text_input_buffer_clear(GX_MULTI_LINE_TEXT_INPUT *text_input_ptr)
76 {
77 UINT status;
78
79 /* Check for invalid caller. */
80 GX_INIT_AND_THREADS_CALLER_CHECKING
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 multi line text input buffer clear function. */
89 status = _gx_multi_line_text_input_buffer_clear(text_input_ptr);
90 return status;
91 }
92
93
