ncurses 6.2 - patch 20200704
[ncurses.git] / form / fld_user.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2004,2010 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *   Author:  Juergen Pfeifer, 1995,1997                                    *
32  ****************************************************************************/
33
34 #include "form.priv.h"
35
36 MODULE_ID("$Id: fld_user.c,v 1.18 2020/05/24 01:40:20 anonymous.maarten Exp $")
37
38 /*---------------------------------------------------------------------------
39 |   Facility      :  libnform  
40 |   Function      :  int set_field_userptr(FIELD *field, void *usrptr)
41 |   
42 |   Description   :  Set the pointer that is reserved in any field to store
43 |                    application relevant informations
44 |
45 |   Return Values :  E_OK         - on success
46 +--------------------------------------------------------------------------*/
47 FORM_EXPORT(int)
48 set_field_userptr(FIELD *field, void *usrptr)
49 {
50   T((T_CALLED("set_field_userptr(%p,%p)"), (void *)field, (void *)usrptr));
51
52   Normalize_Field(field)->usrptr = usrptr;
53   RETURN(E_OK);
54 }
55
56 /*---------------------------------------------------------------------------
57 |   Facility      :  libnform  
58 |   Function      :  void *field_userptr(const FIELD *field)
59 |   
60 |   Description   :  Return the pointer that is reserved in any field to
61 |                    store application relevant informations.
62 |
63 |   Return Values :  Value of pointer. If no such pointer has been set,
64 |                    NULL is returned
65 +--------------------------------------------------------------------------*/
66 FORM_EXPORT(void *)
67 field_userptr(const FIELD *field)
68 {
69   T((T_CALLED("field_userptr(%p)"), (const void *)field));
70   returnVoidPtr(Normalize_Field(field)->usrptr);
71 }
72
73 /* fld_user.c ends here */