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 GX_CALLER_CHECKING_EXTERNS
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _gxe_window_client_width_get PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Kenneth Maxwell, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function checks for errors in the window client width get */
44 /* function call. */
45 /* */
46 /* */
47 /* INPUT */
48 /* */
49 /* window Pointer to window */
50 /* return_width Pointer to destination */
51 /* for client width */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* status Completion status */
56 /* */
57 /* CALLS */
58 /* _gx_window_client_width_get Actual window client width */
59 /* get function */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
70 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_gxe_window_client_width_get(GX_WINDOW * window,GX_VALUE * return_width)74 UINT _gxe_window_client_width_get(GX_WINDOW *window, GX_VALUE *return_width)
75 {
76 UINT status;
77
78 /* Check for appropriate caller. */
79 GX_INIT_AND_THREADS_CALLER_CHECKING
80
81 /* Check for invalid input pointers. */
82 if ((window == GX_NULL) || (return_width == GX_NULL))
83 {
84 return(GX_PTR_ERROR);
85 }
86
87 /* Check for invalid widget. */
88 if (window -> gx_widget_type == 0)
89 {
90 return(GX_INVALID_WIDGET);
91 }
92
93 /* Call the actual window client width get function. */
94 status = _gx_window_client_width_get(window, return_width);
95
96 /* Return completion status. */
97 return status;
98 }
99
100
