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 /**   System Management (System)                                          */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_system.h"
28 
29 /**************************************************************************/
30 /*                                                                        */
31 /*  FUNCTION                                               RELEASE        */
32 /*                                                                        */
33 /*    _gxe_system_screen_stack_create                     PORTABLE C      */
34 /*                                                           6.1          */
35 /*  AUTHOR                                                                */
36 /*                                                                        */
37 /*    Kenneth Maxwell, Microsoft Corporation                              */
38 /*                                                                        */
39 /*  DESCRIPTION                                                           */
40 /*                                                                        */
41 /*    This function checks errors in the system screen stack create       */
42 /*    function.                                                           */
43 /*                                                                        */
44 /*  INPUT                                                                 */
45 /*                                                                        */
46 /*    memory                                Memory address at which to    */
47 /*                                            create system screen stack. */
48 /*    size                                  Memory size in bytes.         */
49 /*                                                                        */
50 /*  OUTPUT                                                                */
51 /*                                                                        */
52 /*    status                                Completion status             */
53 /*                                                                        */
54 /*  CALLS                                                                 */
55 /*                                                                        */
56 /*    _gx_system_screen_stack_create        The actual screen stack       */
57 /*                                            create routine              */
58 /*                                                                        */
59 /*  CALLED BY                                                             */
60 /*                                                                        */
61 /*    Application Code                                                    */
62 /*                                                                        */
63 /*  RELEASE HISTORY                                                       */
64 /*                                                                        */
65 /*    DATE              NAME                      DESCRIPTION             */
66 /*                                                                        */
67 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
68 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
69 /*                                            resulting in version 6.1    */
70 /*                                                                        */
71 /**************************************************************************/
_gxe_system_screen_stack_create(GX_WIDGET ** memory,INT size,UINT control_block_size)72 UINT  _gxe_system_screen_stack_create(GX_WIDGET **memory, INT size, UINT control_block_size)
73 {
74 UINT status;
75 
76     /* Check for invalid input pointers.  */
77     if ((memory == GX_NULL))
78     {
79         return(GX_PTR_ERROR);
80     }
81 
82     /* Check for invalid value.  */
83     if (size <= 0)
84     {
85         return(GX_INVALID_VALUE);
86     }
87 
88     /* Check for invalid control block size. */
89     if (control_block_size != sizeof(GX_SCREEN_STACK_CONTROL))
90     {
91         return(GX_INVALID_SIZE);
92     }
93 
94     /* Call actual screen stack create function.  */
95     status = _gx_system_screen_stack_create(memory, size);
96 
97     /* Return the error status from screen stack create.  */
98     return(status);
99 }
100 
101