ncurses 5.3
[ncurses.git] / doc / html / man / form_userptr.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 Free Software Foundation, Inc.                        *
6   *                                                                          *
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:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
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.                               *
25   *                                                                          *
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       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_userptr.3x,v 1.9 1998/11/29 01:08:39 Rick.Ohnemus Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_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">
38 </HEAD>
39 <BODY>
40 <H1>form_userptr 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>form_userptr</STRONG> - associate application data with a form item
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
53        int set_form_userptr(FORM *form, void *userptr);
54        void* form_userptr(const FORM *form);
55
56
57 </PRE>
58 <H2>DESCRIPTION</H2><PRE>
59        Every form and every form item has a  field  that  can  be
60        used to hold application-specific data (that is, the form-
61        driver code leaves it alone).  These functions get and set
62        the form user pointer field.
63
64
65 </PRE>
66 <H2>RETURN VALUE</H2><PRE>
67        The  function  <STRONG>form_userptr</STRONG>  returns  <STRONG>NULL</STRONG>  on error.  The
68        function <STRONG>set_form_userptr</STRONG> returns one of the following:
69
70        <STRONG>E_OK</STRONG> The routine succeeded.
71
72        <STRONG>E_SYSTEM_ERROR</STRONG>
73             System error occurred (see <STRONG>errno</STRONG>).
74
75
76 </PRE>
77 <H2>SEE ALSO</H2><PRE>
78        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
79
80
81 </PRE>
82 <H2>NOTES</H2><PRE>
83        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
84        file <STRONG>&lt;curses.h&gt;</STRONG>.
85
86
87 </PRE>
88 <H2>PORTABILITY</H2><PRE>
89        These  routines  emulate the System V forms library.  They
90        were not supported on Version 7 or BSD versions.
91
92        The user pointer should be a void pointer.  We leave it as
93        a char pointer for SVr4 compatibility.
94
95
96 </PRE>
97 <H2>AUTHORS</H2><PRE>
98        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
99        curses by Eric S. Raymond.
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114 </PRE>
115 <HR>
116 <ADDRESS>
117 Man(1) output converted with
118 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
119 </ADDRESS>
120 </BODY>
121 </HTML>