xref: /openbsd-src/lib/libform/fld_user.c (revision c7ef0cfc17afcba97172c25e1e3a943e893bc632)
1*c7ef0cfcSnicm /*	$OpenBSD: fld_user.c,v 1.9 2023/10/17 09:52:10 nicm Exp $	*/
202f2426aSmillert /****************************************************************************
3*c7ef0cfcSnicm  * Copyright 2020,2021 Thomas E. Dickey                                     *
4*c7ef0cfcSnicm  * Copyright 1998-2004,2010 Free Software Foundation, Inc.                  *
502f2426aSmillert  *                                                                          *
602f2426aSmillert  * Permission is hereby granted, free of charge, to any person obtaining a  *
702f2426aSmillert  * copy of this software and associated documentation files (the            *
802f2426aSmillert  * "Software"), to deal in the Software without restriction, including      *
902f2426aSmillert  * without limitation the rights to use, copy, modify, merge, publish,      *
1002f2426aSmillert  * distribute, distribute with modifications, sublicense, and/or sell       *
1102f2426aSmillert  * copies of the Software, and to permit persons to whom the Software is    *
1202f2426aSmillert  * furnished to do so, subject to the following conditions:                 *
1302f2426aSmillert  *                                                                          *
1402f2426aSmillert  * The above copyright notice and this permission notice shall be included  *
1502f2426aSmillert  * in all copies or substantial portions of the Software.                   *
1602f2426aSmillert  *                                                                          *
1702f2426aSmillert  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
1802f2426aSmillert  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
1902f2426aSmillert  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
2002f2426aSmillert  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
2102f2426aSmillert  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
2202f2426aSmillert  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
2302f2426aSmillert  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
2402f2426aSmillert  *                                                                          *
2502f2426aSmillert  * Except as contained in this notice, the name(s) of the above copyright   *
2602f2426aSmillert  * holders shall not be used in advertising or otherwise to promote the     *
2702f2426aSmillert  * sale, use or other dealings in this Software without prior written       *
2802f2426aSmillert  * authorization.                                                           *
2902f2426aSmillert  ****************************************************************************/
3002f2426aSmillert 
3102f2426aSmillert /****************************************************************************
3281d8c4e1Snicm  *   Author:  Juergen Pfeifer, 1995,1997                                    *
3302f2426aSmillert  ****************************************************************************/
34ae611fdaStholo 
35ae611fdaStholo #include "form.priv.h"
36ae611fdaStholo 
37*c7ef0cfcSnicm MODULE_ID("$Id: fld_user.c,v 1.9 2023/10/17 09:52:10 nicm Exp $")
386cd90de4Smillert 
39ae611fdaStholo /*---------------------------------------------------------------------------
40ae611fdaStholo |   Facility      :  libnform
41ae611fdaStholo |   Function      :  int set_field_userptr(FIELD *field, void *usrptr)
42ae611fdaStholo |
43ae611fdaStholo |   Description   :  Set the pointer that is reserved in any field to store
44*c7ef0cfcSnicm |                    application relevant information.
45ae611fdaStholo |
46ae611fdaStholo |   Return Values :  E_OK         - on success
47ae611fdaStholo +--------------------------------------------------------------------------*/
FORM_EXPORT(int)48*c7ef0cfcSnicm FORM_EXPORT(int)
4984af20ceSmillert set_field_userptr(FIELD *field, void *usrptr)
50ae611fdaStholo {
51*c7ef0cfcSnicm   T((T_CALLED("set_field_userptr(%p,%p)"), (void *)field, (void *)usrptr));
5281d8c4e1Snicm 
53ae611fdaStholo   Normalize_Field(field)->usrptr = usrptr;
54ae611fdaStholo   RETURN(E_OK);
55ae611fdaStholo }
56ae611fdaStholo 
57ae611fdaStholo /*---------------------------------------------------------------------------
58ae611fdaStholo |   Facility      :  libnform
59ae611fdaStholo |   Function      :  void *field_userptr(const FIELD *field)
60ae611fdaStholo |
61ae611fdaStholo |   Description   :  Return the pointer that is reserved in any field to
62*c7ef0cfcSnicm |                    store application relevant information.
63ae611fdaStholo |
64ae611fdaStholo |   Return Values :  Value of pointer. If no such pointer has been set,
65ae611fdaStholo |                    NULL is returned
66ae611fdaStholo +--------------------------------------------------------------------------*/
67*c7ef0cfcSnicm FORM_EXPORT(void *)
field_userptr(const FIELD * field)6884af20ceSmillert field_userptr(const FIELD *field)
69ae611fdaStholo {
70*c7ef0cfcSnicm   T((T_CALLED("field_userptr(%p)"), (const void *)field));
7181d8c4e1Snicm   returnVoidPtr(Normalize_Field(field)->usrptr);
72ae611fdaStholo }
73ae611fdaStholo 
74ae611fdaStholo /* fld_user.c ends here */
75