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 /** Widget Management (Widget) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_widget.h"
28
29 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_widget_height_get PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks for errors in the widget height get function */
45 /* call. */
46 /* */
47 /* INPUT */
48 /* */
49 /* widget Pointer to widget */
50 /* return_height Pointer to destination for */
51 /* widget height */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* status Completion status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _gx_widget_height_get Actual widget height get */
60 /* function */
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_widget_height_get(GX_WIDGET * widget,GX_VALUE * return_height)75 UINT _gxe_widget_height_get(GX_WIDGET *widget, GX_VALUE *return_height)
76 {
77 UINT status;
78
79 /* Check for appropriate caller. */
80 GX_INIT_AND_THREADS_CALLER_CHECKING
81
82 /* Check for invalid input pointers. */
83 if ((widget == GX_NULL) || (return_height == GX_NULL))
84 {
85 return(GX_PTR_ERROR);
86 }
87
88 /* Check for invalid widget.*/
89 if (widget -> gx_widget_type == 0)
90 {
91 return(GX_INVALID_WIDGET);
92 }
93
94 /* Call actual widget height get function. */
95 status = _gx_widget_height_get(widget, return_height);
96
97 /* Return successful completion. */
98 return(status);
99 }
100
101
