ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / form_userptr.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018,2020 Thomas E. Dickey                                     *
5   * Copyright 1998-2010,2015 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.17 2020/03/28 19:06:28 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_userptr 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_userptr 3x</H1>
44 <PRE>
45 <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>                                              <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>set_form_userptr</STRONG>, <STRONG>form_userptr</STRONG> - associate application data with a form
52        item
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57        int set_form_userptr(FORM *form, void *userptr);
58        void* form_userptr(const FORM *form);
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        Every form and every form item has a field that can  be  used  to  hold
63        application-specific  data  (that  is,  the  form-driver code leaves it
64        alone).  These functions get and set the form user pointer field.
65
66
67 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
68        The function <STRONG>form_userptr</STRONG> returns a pointer (which may  be  <STRONG>NULL</STRONG>).   It
69        does not set <STRONG>errno</STRONG>.
70
71        The function <STRONG>set_form_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success).
72
73
74 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
75        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
76
77
78 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
79        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
80        <STRONG>&lt;curses.h&gt;</STRONG>.
81
82
83 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
84        These routines emulate the System V forms library.  They were not  sup-
85        ported on Version 7 or BSD versions.
86
87        The user pointer is a void pointer.  We chose not to leave it as a char
88        pointer for SVr4 compatibility.
89
90
91 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
92        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
93        Raymond.
94
95
96
97                                                               <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
98 </PRE>
99 <div class="nav">
100 <ul>
101 <li><a href="#h2-NAME">NAME</a></li>
102 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
103 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
104 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
105 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
106 <li><a href="#h2-NOTES">NOTES</a></li>
107 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
108 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
109 </ul>
110 </div>
111 </BODY>
112 </HTML>