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