1 .\"***************************************************************************
2 .\" Copyright 2018-2022,2023 Thomas E. Dickey *
3 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
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: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
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. *
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 *
28 .\"***************************************************************************
30 .\" $Id: form_userptr.3x,v 1.32 2023/10/07 21:19:07 tom Exp $
31 .TH form_userptr 3X 2023-10-07 "ncurses 6.4" "Library calls"
33 \fBset_form_userptr\fP,
35 associate application data with a form item
40 \fBint set_form_userptr(FORM *\fIform\fP, void *\fIuserptr\fP);
41 \fBvoid* form_userptr(const FORM *\fIform\fP);
44 Every form and every form item has a field that can be used to hold
45 application-specific data (that is, the form-driver code leaves it alone).
46 These functions get and set the form user pointer field.
48 The function \fBform_userptr\fP returns a pointer (which may be \fBNULL\fP).
49 It does not set \fBerrno\fP.
51 The function \fBset_form_userptr\fP returns \fBE_OK\fP (success).
53 The header file \fB<form.h>\fP automatically includes the header file
56 These routines emulate the System V forms library.
57 They were not supported on
58 Version 7 or BSD versions.
60 The user pointer is a void pointer.
61 We chose not to leave it as a char pointer for SVr4 compatibility.
64 Manual pages and adaptation for new curses by Eric S. Raymond.