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 /**************************************************************************/
30 /* */
31 /* FUNCTION RELEASE */
32 /* */
33 /* _gxe_screen_stack_reset PORTABLE C */
34 /* 6.1 */
35 /* AUTHOR */
36 /* */
37 /* Kenneth Maxwell, Microsoft Corporation */
38 /* */
39 /* DESCRIPTION */
40 /* */
41 /* This function checks errors in the screen stack reset function. */
42 /* */
43 /* INPUT */
44 /* */
45 /* control Screen stack control block. */
46 /* */
47 /* OUTPUT */
48 /* */
49 /* status Completion status */
50 /* */
51 /* CALLS */
52 /* */
53 /* _gx_screen_stack_reset The actual screen stack */
54 /* reset routine */
55 /* */
56 /* CALLED BY */
57 /* */
58 /* Application Code */
59 /* */
60 /* RELEASE HISTORY */
61 /* */
62 /* DATE NAME DESCRIPTION */
63 /* */
64 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
65 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
66 /* resulting in version 6.1 */
67 /* */
68 /**************************************************************************/
_gxe_screen_stack_reset(GX_SCREEN_STACK_CONTROL * control)69 UINT _gxe_screen_stack_reset(GX_SCREEN_STACK_CONTROL *control)
70 {
71 UINT status;
72
73 /* Check for invalid input pointers. */
74 if ((control == GX_NULL))
75 {
76 return(GX_PTR_ERROR);
77 }
78
79 /* Call actual screen stack create function. */
80 status = _gx_screen_stack_reset(control);
81
82 /* Return the error status from screen stack reset. */
83 return(status);
84 }
85
86
