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