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 /** Utility (Utility) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_utility.h"
28
29
30 /**************************************************************************/
31 /* */
32 /* FUNCTION RELEASE */
33 /* */
34 /* _gxe_utility_rectangle_define PORTABLE C */
35 /* 6.1 */
36 /* AUTHOR */
37 /* */
38 /* Kenneth Maxwell, Microsoft Corporation */
39 /* */
40 /* DESCRIPTION */
41 /* */
42 /* This function checks for errors in the utility rectangle define */
43 /* function call. */
44 /* */
45 /* INPUT */
46 /* */
47 /* rectangle Rectangle to define */
48 /* left Left most coordinate */
49 /* top Top most coordinate */
50 /* right Right most coordinate */
51 /* bottom Bottom most coordinate */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* None */
56 /* */
57 /* CALLS */
58 /* */
59 /* _gx_utility_rectangle_define Actual utility rectangle */
60 /* define 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_utility_rectangle_define(GX_RECTANGLE * rectangle,GX_VALUE left,GX_VALUE top,GX_VALUE right,GX_VALUE bottom)75 UINT _gxe_utility_rectangle_define(GX_RECTANGLE *rectangle, GX_VALUE left,
76 GX_VALUE top, GX_VALUE right, GX_VALUE bottom)
77 {
78
79 /* Check for invalid input pointers. */
80 if (rectangle == GX_NULL)
81 {
82 return GX_PTR_ERROR;
83 }
84
85 /* Call the actual utility rectangle define function. */
86 return (_gx_utility_rectangle_define(rectangle, left, top, right, bottom));
87 }
88
89
