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 /** Window Management (Window) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_window.h"
29
30 /**************************************************************************/
31 /* */
32 /* FUNCTION RELEASE */
33 /* */
34 /* _gxe_window_scroll_info_get PORTABLE C */
35 /* 6.1 */
36 /* AUTHOR */
37 /* */
38 /* Kenneth Maxwell, Microsoft Corporation */
39 /* */
40 /* DESCRIPTION */
41 /* */
42 /* This function checks for errors in the window scroll info get */
43 /* function call. */
44 /* */
45 /* INPUT */
46 /* */
47 /* window Pointer to window */
48 /* type GX_SCROLLBAR_HORIZONTAL */
49 /* or GX_SCROLLBAR_VERTICAL */
50 /* return_scroll_info Pointer to destination for */
51 /* scroll info */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* status Completion status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _gx_window_scroll_info_get Actual window scroll info */
60 /* get function */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
71 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_gxe_window_scroll_info_get(GX_WINDOW * window,ULONG type,GX_SCROLL_INFO * return_scroll_info)75 UINT _gxe_window_scroll_info_get(GX_WINDOW *window, ULONG type, GX_SCROLL_INFO *return_scroll_info)
76 {
77 UINT status;
78
79 /* Check for invalid input pointers. */
80 if ((window == GX_NULL) || (return_scroll_info == GX_NULL))
81 {
82 return(GX_PTR_ERROR);
83 }
84
85 /* Check for invalid widget. */
86 if (window -> gx_widget_type == 0)
87 {
88 return(GX_INVALID_WIDGET);
89 }
90
91 /* Check for invalid type. */
92 if ((type != GX_SCROLLBAR_HORIZONTAL) && (type != GX_SCROLLBAR_VERTICAL))
93 {
94 return(GX_INVALID_TYPE);
95 }
96
97 /* Call actual window scroll info get function. */
98 status = _gx_window_scroll_info_get(window, type, return_scroll_info);
99
100 /* Return successful completion. */
101 return(status);
102 }
103
104
