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 /** Progress Bar Management (Progress Bar) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23 /* Include necessary system files. */
24
25 #include "gx_api.h"
26 #include "gx_progress_bar.h"
27
28 /* Bring in externs for caller checking code. */
29 GX_CALLER_CHECKING_EXTERNS
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _gxe_progress_bar_range_set PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Kenneth Maxwell, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function checks for errors in progress bar range set call. */
44 /* */
45 /* INPUT */
46 /* */
47 /* progress_bar Progress Bar control block */
48 /* min_value Minmum value */
49 /* max_value Maxmum value */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* status Completion status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _gx_progress_bar_range_set Actual progress bar range */
58 /* set 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_progress_bar_range_set(GX_PROGRESS_BAR * progress_bar,INT min_value,INT max_value)73 UINT _gxe_progress_bar_range_set(GX_PROGRESS_BAR *progress_bar, INT min_value, INT max_value)
74 {
75 UINT status;
76
77 /* Check for invalid caller. */
78 GX_INIT_AND_THREADS_CALLER_CHECKING
79
80 /* Check for invalid pointer. */
81 if (progress_bar == GX_NULL)
82 {
83 return(GX_PTR_ERROR);
84 }
85
86 /* Call actual progress bar range set function. */
87 status = _gx_progress_bar_range_set(progress_bar, min_value, max_value);
88
89 /* Return completion status. */
90 return(status);
91 }
92
93
