3 ****************************************************************************
4 * Copyright (c) 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 ****************************************************************************
30 * @Id: form_field_userptr.3x,v 1.11 2015/12/05 23:01:56 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>form_field_userptr 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">form_field_userptr 3x</H1>
44 <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG> <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>set_field_userptr</STRONG>, <STRONG>field_userptr</STRONG> - associate application
51 data with a form field
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
56 int set_field_userptr(FIELD *field, void*userptr);
57 void *field_userptr(const FIELD *field);
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61 Every form field has a field that can be used to hold
62 application-specific data (that is, the form-driver code
63 leaves it alone). These functions get and set that field.
66 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
67 The function <STRONG>field_userptr</STRONG> returns a pointer (which may be
68 <STRONG>NULL</STRONG>). It does not set errno.
70 The function <STRONG>set_field_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success).
73 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
74 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
77 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
78 The header file <STRONG><form.h></STRONG> automatically includes the header
79 file <STRONG><curses.h></STRONG>.
82 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
83 These routines emulate the System V forms library. They
84 were not supported on Version 7 or BSD versions.
86 The user pointer is a void pointer. We chose not to leave
87 it as a char pointer for SVr4 compatibility.
90 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
91 Juergen Pfeifer. Manual pages and adaptation for new
92 curses by Eric S. Raymond.
96 <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>
100 <li><a href="#h2-NAME">NAME</a></li>
101 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
102 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
103 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
104 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
105 <li><a href="#h2-NOTES">NOTES</a></li>
106 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
107 <li><a href="#h2-AUTHORS">AUTHORS</a></li>