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 /** Canvas Management (Canvas) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_system.h"
28 #include "gx_utility.h"
29 #include "gx_canvas.h"
30
31
32 /* Bring in externs for caller checking code. */
33 GX_CALLER_CHECKING_EXTERNS
34
35
36 /**************************************************************************/
37 /* */
38 /* FUNCTION RELEASE */
39 /* */
40 /* _gxe_canvas_delete PORTABLE C */
41 /* 6.1 */
42 /* AUTHOR */
43 /* */
44 /* Kenneth Maxwell, Microsoft Corporation */
45 /* */
46 /* DESCRIPTION */
47 /* */
48 /* This function checks for errors in the canvas delete call. */
49 /* */
50 /* INPUT */
51 /* */
52 /* canvas Canvas control block */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* _gx_canvas_delete Actual canvas delete call */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
71 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_gxe_canvas_delete(GX_CANVAS * canvas)75 UINT _gxe_canvas_delete(GX_CANVAS *canvas)
76 {
77 UINT status;
78
79 /* Check for appropriate caller. */
80 GX_INIT_AND_THREADS_CALLER_CHECKING
81
82 /* Check for the invalid input pointers. */
83 if (canvas == GX_NULL)
84 {
85 return(GX_PTR_ERROR);
86 }
87
88 if (canvas ->gx_canvas_id != GX_CANVAS_ID)
89 {
90 return (GX_INVALID_CANVAS);
91 }
92
93 /* Call the actual canvas delete function. */
94 status = _gx_canvas_delete(canvas);
95
96 /* Return completion status. */
97 return status;
98 }
99
100
