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 /** Sprite Management (Sprite) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_sprite.h"
28
29 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_sprite_stop PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This service checks for error in the sprite stop call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* sprite Pointer to sprite widget */
49 /* control block */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* status Completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _gx_sprite_stop The actual sprite stop call */
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_sprite_stop(GX_SPRITE * sprite)72 UINT _gxe_sprite_stop(GX_SPRITE *sprite)
73 {
74 UINT status;
75
76 /* Check for appropriate caller. */
77 GX_THREADS_ONLY_CALLER_CHECKING
78
79 /* Check for the invalid input pointers. */
80 if (sprite == GX_NULL)
81 {
82 return(GX_PTR_ERROR);
83 }
84
85 if (sprite -> gx_widget_type == 0)
86 {
87 return(GX_INVALID_WIDGET);
88 }
89
90 /* Call the actual sprite stop function. */
91 status = _gx_sprite_stop(sprite);
92
93 /* Return completion status. */
94 return(status);
95 }
96
97
