1 <!DOCTYPE HTML PUBLIC
"-//IETF//DTD HTML 2.0//EN">
4 ****************************************************************************
5 * Copyright (c) 1998-2006,2010 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_userptr.3x,v 1.13 2010/12/04 18:40:45 tom Exp @
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">
40 <H1>form_userptr
3x
</H1>
43 <!-- Manpage converted by man2html 3.0.1 -->
44 <STRONG><A HREF=
"form_userptr.3x.html">form_userptr(
3x)
</A></STRONG> <STRONG><A HREF=
"form_userptr.3x.html">form_userptr(
3x)
</A></STRONG>
51 <STRONG>form_userptr
</STRONG> - associate application data with a form item
55 <H2>SYNOPSIS
</H2><PRE>
56 <STRONG>#include
</STRONG> <STRONG><form.h
></STRONG>
57 int set_form_userptr(FORM *form, void *userptr);
58 void* form_userptr(const FORM *form);
62 <H2>DESCRIPTION
</H2><PRE>
63 Every form and every form item has a field that can be
64 used to hold application-specific data (that is, the form-
65 driver code leaves it alone). These functions get and set
66 the form user pointer field.
70 <H2>RETURN VALUE
</H2><PRE>
71 The function
<STRONG>form_userptr
</STRONG> returns a pointer (which may be
72 <STRONG>NULL
</STRONG>). It does not set errno.
74 The function
<STRONG>set_form_userptr
</STRONG> returns
<STRONG>E_OK
</STRONG> (success).
78 <H2>SEE ALSO
</H2><PRE>
79 <STRONG><A HREF=
"ncurses.3x.html">curses(
3x)
</A></STRONG>,
<STRONG><A HREF=
"form.3x.html">form(
3x)
</A></STRONG>.
84 The header file
<STRONG><form.h
></STRONG> automatically includes the header
85 file
<STRONG><curses.h
></STRONG>.
89 <H2>PORTABILITY
</H2><PRE>
90 These routines emulate the System V forms library. They
91 were not supported on Version
7 or BSD versions.
93 The user pointer is a void pointer. We chose not to leave
94 it as a char pointer for SVr4 compatibility.
99 Juergen Pfeifer. Manual pages and adaptation for new
100 curses by Eric S. Raymond.
104 <STRONG><A HREF=
"form_userptr.3x.html">form_userptr(
3x)
</A></STRONG>
108 Man(
1) output converted with
109 <a href=
"http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html
</a>