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 /** Text Input Cursor Managment (Text Input Cursor) */
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_text_input_cursor.h"
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _gxe_text_input_cursor_blink_interval_set PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Kenneth Maxwell, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function checks for errors in the text input cursor blink */
44 /* interval set function call. */
45 /* */
46 /* */
47 /* INPUT */
48 /* */
49 /* cursor_ptr Pointer to text input cursor */
50 /* control block */
51 /* blink_interval Cursor blink interval value */
52 /* to be set */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* _gx_text_input_cursor_blink_interval_set */
61 /* Actual text input cursor */
62 /* blink interval set function */
63 /* */
64 /* CALLED BY */
65 /* */
66 /* Application Code */
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_text_input_cursor_blink_interval_set(GX_TEXT_INPUT_CURSOR * cursor_ptr,GX_UBYTE blink_interval)77 UINT _gxe_text_input_cursor_blink_interval_set(GX_TEXT_INPUT_CURSOR *cursor_ptr, GX_UBYTE blink_interval)
78 {
79 UINT status;
80
81 if (!cursor_ptr)
82 {
83 return(GX_PTR_ERROR);
84 }
85
86 if (blink_interval == 0)
87 {
88 return(GX_INVALID_VALUE);
89 }
90
91 status = _gx_text_input_cursor_blink_interval_set(cursor_ptr, blink_interval);
92
93 return(status);
94 }
95
96
