| 1 |
.\"*************************************************************************** |
| 2 |
.\" Copyright 2018-2023,2024 Thomas E. Dickey * |
| 3 |
.\" Copyright 1998-2010,2015 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 |
.\" $Id: form_field_userptr.3x,v 1.32 2024/12/28 21:26:21 tom Exp $ |
| 31 |
.TH field_userptr 3FORM 2024-12-28 "ncurses 6.6" "Library calls" |
| 32 |
.SH NAME |
| 33 |
\fBset_field_userptr\fP, |
| 34 |
\fBfield_userptr\fP \- |
| 35 |
associate application data with a form field |
| 36 |
.SH SYNOPSIS |
| 37 |
.nf |
| 38 |
\fB#include <form.h> |
| 39 |
.PP |
| 40 |
\fBint set_field_userptr(FIELD *\fIfield\fP, void *\fIuserptr\fP); |
| 41 |
\fBvoid *field_userptr(const FIELD *\fIfield\fP); |
| 42 |
.fi |
| 43 |
.SH DESCRIPTION |
| 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 |
| 47 |
that field. |
| 48 |
.SH RETURN VALUE |
| 49 |
The function \fBfield_userptr\fP returns a pointer (which may be |
| 50 |
.IR NULL ")." |
| 51 |
It does not set \fBerrno\fP. |
| 52 |
.PP |
| 53 |
The function \fBset_field_userptr\fP returns \fBE_OK\fP (success). |
| 54 |
.SH PORTABILITY |
| 55 |
These routines emulate the System V forms library. |
| 56 |
They were not supported on |
| 57 |
Version 7 or BSD versions. |
| 58 |
.PP |
| 59 |
The user pointer is a void pointer. |
| 60 |
We chose not to leave it as a char pointer for SVr4 compatibility. |
| 61 |
.SH AUTHORS |
| 62 |
Juergen Pfeifer. |
| 63 |
Manual pages and adaptation for new curses by Eric S. Raymond. |
| 64 |
.SH SEE ALSO |
| 65 |
\fB\%ncurses\fP(3NCURSES), |
| 66 |
\fB\%form\fP(3FORM) |