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