2 .\"***************************************************************************
3 .\" Copyright 2018-2022,2023 Thomas E. Dickey *
4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
6 .\" Permission is hereby granted, free of charge, to any person obtaining a *
7 .\" copy of this software and associated documentation files (the *
8 .\" "Software"), to deal in the Software without restriction, including *
9 .\" without limitation the rights to use, copy, modify, merge, publish, *
10 .\" distribute, distribute with modifications, sublicense, and/or sell *
11 .\" copies of the Software, and to permit persons to whom the Software is *
12 .\" furnished to do so, subject to the following conditions: *
14 .\" The above copyright notice and this permission notice shall be included *
15 .\" in all copies or substantial portions of the Software. *
17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 .\" Except as contained in this notice, the name(s) of the above copyright *
26 .\" holders shall not be used in advertising or otherwise to promote the *
27 .\" sale, use or other dealings in this Software without prior written *
29 .\"***************************************************************************
31 .\" $Id: form_field_userptr.3x,v 1.22 2023/09/16 23:39:54 tom Exp $
32 .TH form_field_userptr 3X 2023-09-16 "ncurses 6.4" "Library calls"
34 \fBset_field_userptr\fP,
35 \fBfield_userptr\fP \-
36 associate application data with a form field
38 \fB#include <form.h>\fP
40 \fBint set_field_userptr(FIELD *\fIfield\fB, void *\fIuserptr\fB);\fR
42 \fBvoid *field_userptr(const FIELD *\fIfield\fB);\fR
44 Every form field has a field that can be used to hold application-specific data
45 (that is, the form-driver code leaves it alone).
46 These functions get and set
49 The function \fBfield_userptr\fP returns a pointer (which may be \fBNULL\fP).
50 It does not set \fBerrno\fP.
52 The function \fBset_field_userptr\fP returns \fBE_OK\fP (success).
54 \fBcurses\fP(3X), \fBform\fP(3X).
56 The header file \fB<form.h>\fP automatically includes the header file
59 These routines emulate the System V forms library.
60 They were not supported on
61 Version 7 or BSD versions.
63 The user pointer is a void pointer.
64 We chose not to leave it as a char pointer for SVr4 compatibility.
67 Manual pages and adaptation for new curses by Eric S. Raymond.