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