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 /**   Prompt Management (Prompt)                                          */
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 #include "gx_button.h"
29 
30 /* Bring in externs for caller checking code.  */
31 GX_CALLER_CHECKING_EXTERNS
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _gxe_icon_button_pixelmap_set                       PORTABLE C      */
38 /*                                                           6.1          */
39 /*  AUTHOR                                                                */
40 /*                                                                        */
41 /*    Kenneth Maxwell, Microsoft Corporation                              */
42 /*                                                                        */
43 /*  DESCRIPTION                                                           */
44 /*                                                                        */
45 /*    This function checks for errors in the icon pixelmap set function.  */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    button                                Button control block          */
50 /*    pixelmap_id                           Resource ID of the pixelmap   */
51 /*                                            used for drawing button     */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*   _gx_icon_button_pixelmap_set           Actual icon button pixelmap   */
59 /*                                            set call                    */
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_icon_button_pixelmap_set(GX_ICON_BUTTON * button,GX_RESOURCE_ID pixelmap_id)74 UINT  _gxe_icon_button_pixelmap_set(GX_ICON_BUTTON *button,
75                                     GX_RESOURCE_ID pixelmap_id)
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 (button == GX_NULL)
84     {
85         return(GX_PTR_ERROR);
86     }
87 
88     /* Call the actual icon pixelmap set function.  */
89     status = _gx_icon_button_pixelmap_set(button, pixelmap_id);
90 
91     /* Return completion status.  */
92     return status;
93 }
94 
95