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