1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
4 ****************************************************************************
5 * Copyright (c) 1998 Free Software Foundation, Inc. *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
30 ****************************************************************************
31 * @Id: form_field_userptr.3x,v 1.6 1998/11/29 01:07:05 Rick.Ohnemus Exp @
35 <TITLE>form_field_userptr 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 <H1>form_field_userptr 3x</H1>
43 <!-- Manpage converted by man2html 3.0.1 -->
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>
51 <STRONG>form_field_userptr</STRONG> - associate application data with a
56 <H2>SYNOPSIS</H2><PRE>
57 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
58 int set_field_userptr(FIELD *field, void*userptr);
59 void *field_userptr(const FIELD *field);
63 <H2>DESCRIPTION</H2><PRE>
64 Every form field has a field that can be used to hold
65 application-specific data (that is, the form-driver code
66 leaves it alone). These functions get and set that field.
70 <H2>RETURN VALUE</H2><PRE>
71 The function <STRONG>field_userptr</STRONG> returns <STRONG>NULL</STRONG> on error. The
72 function <STRONG>set_field_userptr</STRONG> returns one of the following:
74 <STRONG>E_OK</STRONG> The routine succeeded.
76 <STRONG>E_SYSTEM_ERROR</STRONG>
77 System error occurred (see <STRONG>errno</STRONG>).
81 <H2>SEE ALSO</H2><PRE>
82 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
87 The header file <STRONG><form.h></STRONG> automatically includes the header
88 file <STRONG><curses.h></STRONG>.
92 <H2>PORTABILITY</H2><PRE>
93 These routines emulate the System V forms library. They
94 were not supported on Version 7 or BSD versions.
96 The user pointer should be a void pointer. We leave it as
97 a char pointer for SVr4 compatibility.
101 <H2>AUTHORS</H2><PRE>
102 Juergen Pfeifer. Manual pages and adaptation for new
103 curses by Eric S. Raymond.
107 <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>
111 Man(1) output converted with
112 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>