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 /**   Scrollbar Management (Scrollbar)                                    */
19 /**                                                                       */
20 /**************************************************************************/
21 
22 #define GX_SOURCE_CODE
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_scrollbar.h"
28 
29 /* Bring in externs for caller checking code.  */
30 GX_CALLER_CHECKING_EXTERNS
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gxe_scrollbar_value_set                            PORTABLE C      */
37 /*                                                           6.1          */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Kenneth Maxwell, Microsoft Corporation                              */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This service checks errors in the scrollbar value set function call */
45 /*                                                                        */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    scrollbar                             Scrollbar control block       */
50 /*    value                                 New scrollbar value           */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    status               Completion status                              */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_scrollbar_value_set The actual function                         */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    Application Code                                                    */
63 /*                                                                        */
64 /*  RELEASE HISTORY                                                       */
65 /*                                                                        */
66 /*    DATE              NAME                      DESCRIPTION             */
67 /*                                                                        */
68 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
69 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
70 /*                                            resulting in version 6.1    */
71 /*                                                                        */
72 /**************************************************************************/
_gxe_scrollbar_value_set(GX_SCROLLBAR * scrollbar,INT value)73 UINT _gxe_scrollbar_value_set(GX_SCROLLBAR *scrollbar, INT value)
74 {
75 UINT status;
76 
77     /* Check for appropriate caller.  */
78     GX_INIT_AND_THREADS_CALLER_CHECKING
79 
80     /* Check for invalid input pointers.  */
81     if ((scrollbar == GX_NULL))
82     {
83         return(GX_PTR_ERROR);
84     }
85 
86     /* Check for invalid widget.  */
87     if (scrollbar -> gx_widget_type == 0)
88     {
89         return(GX_INVALID_WIDGET);
90     }
91 
92     /* Call the actual function.  */
93     status = _gx_scrollbar_value_set(scrollbar, value);
94 
95     /* Return successful completion.  */
96     return(status);
97 }
98 
99