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 Button Management (Button) */
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_button.h"
30
31
32 /* Bring in externs for caller checking code. */
33 GX_CALLER_CHECKING_EXTERNS
34 /**************************************************************************/
35 /* */
36 /* FUNCTION RELEASE */
37 /* */
38 /* _gxe_text_button_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 text button text id set */
47 /* function call. */
48 /* */
49 /* */
50 /* INPUT */
51 /* */
52 /* button Button control block */
53 /* text_id Resource ID of the text string*/
54 /* */
55 /* OUTPUT */
56 /* */
57 /* status Completion status */
58 /* */
59 /* CALLS */
60 /* */
61 /* _gx_text_button_text_id_set Actual text button text ID */
62 /* set 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_text_button_text_id_set(GX_TEXT_BUTTON * button,GX_RESOURCE_ID text_id)77 UINT _gxe_text_button_text_id_set(GX_TEXT_BUTTON *button, GX_RESOURCE_ID text_id)
78 {
79 UINT status;
80
81 /* Check for invalid caller. */
82 GX_INIT_AND_THREADS_CALLER_CHECKING
83
84 if (!button)
85 {
86 return(GX_PTR_ERROR);
87 }
88
89 if (button -> gx_widget_type == 0)
90 {
91 return(GX_INVALID_WIDGET);
92 }
93
94 /* Call the actual function. */
95 status = _gx_text_button_text_id_set(button, text_id);
96
97 /* Return completion status. */
98 return(status);
99 }
100
101
