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 /** Screen Stack Management (Screen Stack) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_screen_stack.h"
28
29 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_screen_stack_push PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks errors in the screen stack push function. */
45 /* */
46 /* INPUT */
47 /* */
48 /* control Pointer of stack entry */
49 /* screen Screen pointer to push */
50 /* new_screen Pointer of new screen */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_screen_stack_push The actual screen stack push */
59 /* routine */
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_screen_stack_push(GX_SCREEN_STACK_CONTROL * control,GX_WIDGET * screen,GX_WIDGET * new_screen)74 UINT _gxe_screen_stack_push(GX_SCREEN_STACK_CONTROL *control, GX_WIDGET *screen, GX_WIDGET *new_screen)
75 {
76 UINT status;
77
78 /* Check for appropriate caller. */
79 GX_INIT_AND_THREADS_CALLER_CHECKING
80
81 /* Check for invalid input pointers. */
82 if ((control == GX_NULL) || (screen == GX_NULL) || (new_screen == GX_NULL))
83 {
84 return(GX_PTR_ERROR);
85 }
86
87 /* Call actual screen stack PUSH function. */
88 status = _gx_screen_stack_push(control, screen, new_screen);
89
90 /* Return the error status from screen stack push. */
91 return(status);
92 }
93
94
