1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** GUIX Component */
17 /** */
18 /** Screen Stack Management (Screen Stack) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_screen_stack.h"
29
30 /* Bring in externs for caller checking code. */
31 GX_CALLER_CHECKING_EXTERNS
32
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _gxe_screen_stack_pop PORTABLE C */
38 /* 6.1 */
39 /* AUTHOR */
40 /* */
41 /* Kenneth Maxwell, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function checks errors in the screen stack pop function. */
46 /* */
47 /* INPUT */
48 /* */
49 /* control Screen stack control block. */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* status Completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _gx_screen_stack_pop The actual screen stack */
58 /* pop routine */
59 /* */
60 /* CALLED BY */
61 /* */
62 /* Application Code */
63 /* */
64 /* RELEASE HISTORY */
65 /* */
66 /* DATE NAME DESCRIPTION */
67 /* */
68 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
69 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
70 /* resulting in version 6.1 */
71 /* */
72 /**************************************************************************/
_gxe_screen_stack_pop(GX_SCREEN_STACK_CONTROL * control)73 UINT _gxe_screen_stack_pop(GX_SCREEN_STACK_CONTROL *control)
74 {
75 UINT status;
76
77 /* Check for appropriate caller. */
78 GX_INIT_AND_THREADS_CALLER_CHECKING
79
80 /* Check for invalid input pointers. */
81 if (control == GX_NULL)
82 {
83 return(GX_PTR_ERROR);
84 }
85
86 /* Call actual screen stack pop function. */
87 status = _gx_screen_stack_pop(control);
88
89 /* Return the error status from screen stack pop. */
90 return(status);
91 }
92
93
