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_pop 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 pop function. */
45 /* */
46 /* INPUT */
47 /* */
48 /* control Screen stack control block. */
49 /* */
50 /* OUTPUT */
51 /* */
52 /* status Completion status */
53 /* */
54 /* CALLS */
55 /* */
56 /* _gx_screen_stack_pop The actual screen stack */
57 /* pop 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_screen_stack_pop(GX_SCREEN_STACK_CONTROL * control)72 UINT _gxe_screen_stack_pop(GX_SCREEN_STACK_CONTROL *control)
73 {
74 UINT status;
75
76 /* Check for appropriate caller. */
77 GX_INIT_AND_THREADS_CALLER_CHECKING
78
79 /* Check for invalid input pointers. */
80 if (control == GX_NULL)
81 {
82 return(GX_PTR_ERROR);
83 }
84
85 /* Call actual screen stack pop function. */
86 status = _gx_screen_stack_pop(control);
87
88 /* Return the error status from screen stack pop. */
89 return(status);
90 }
91
92
