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 /** System Management (System) */
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
29 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_system_timer_start PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks for errors in system timer start call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* owner Pointer to widget control */
49 /* block */
50 /* timer_id ID of timer */
51 /* initial ticks Initial expiration ticks */
52 /* reschedule_ticks Periodic expiration ticks */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* _gx_system_timer_start Actual system timer start call*/
61 /* */
62 /* CALLED BY */
63 /* */
64 /* GUIX Application */
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_system_timer_start(GX_WIDGET * owner,UINT timer_id,UINT initial_ticks,UINT reschedule_ticks)75 UINT _gxe_system_timer_start(GX_WIDGET *owner, UINT timer_id, UINT initial_ticks, UINT reschedule_ticks)
76 {
77 UINT status;
78
79 /* Check for invalid caller. */
80 GX_INIT_AND_THREADS_CALLER_CHECKING
81
82 /* Check for no more timers. */
83 if (!_gx_system_free_timer_list)
84 {
85 return(GX_OUT_OF_TIMERS);
86 }
87
88 /* Check for invalid pointer. */
89 if (owner == GX_NULL)
90 {
91 return(GX_PTR_ERROR);
92 }
93
94 /* Check for invalid widget. */
95 if (owner -> gx_widget_type <= 0)
96 {
97 return(GX_INVALID_WIDGET);
98 }
99
100 /* Check for invalid time values. */
101 if (initial_ticks == 0)
102 {
103 return(GX_INVALID_VALUE);
104 }
105
106 /* Call actual system timer start. */
107 status = _gx_system_timer_start(owner, timer_id, initial_ticks, reschedule_ticks);
108
109 /* Return status. */
110 return(status);
111 }
112
113
