ncursesw-morphos/doc/html/man/form_userptr.3x.html

110 lines
4.4 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2002-10-13 11:35:53 +08:00
<!--
* t
****************************************************************************
* Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
2002-10-13 11:35:53 +08:00
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* "Software"), to deal in the Software without restriction, including *
* without limitation the rights to use, copy, modify, merge, publish, *
* distribute, distribute with modifications, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included *
* in all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
* *
* Except as contained in this notice, the name(s) of the above copyright *
* holders shall not be used in advertising or otherwise to promote the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
* @Id: form_userptr.3x,v 1.13 2010/12/04 18:40:45 tom Exp @
2002-10-13 11:35:53 +08:00
-->
1997-05-15 12:00:00 +08:00
<HTML>
2002-10-13 11:35:53 +08:00
<HEAD>
<TITLE>form_userptr 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
1999-10-24 12:32:42 +08:00
<BODY>
2002-10-13 11:35:53 +08:00
<H1>form_userptr 3x</H1>
<HR>
1997-05-15 12:00:00 +08:00
<PRE>
2000-07-09 10:46:08 +08:00
<!-- Manpage converted by man2html 3.0.1 -->
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG> <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
2004-02-09 10:15:26 +08:00
2000-07-09 10:46:08 +08:00
</PRE>
<H2>NAME</H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG>form_userptr</STRONG> - associate application data with a form item
1997-05-15 12:00:00 +08:00
</PRE>
<H2>SYNOPSIS</H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
1998-03-01 12:21:12 +08:00
int set_form_userptr(FORM *form, void *userptr);
void* form_userptr(const FORM *form);
1997-05-15 12:00:00 +08:00
</PRE>
<H2>DESCRIPTION</H2><PRE>
Every form and every form item has a field that can be
1997-05-15 12:00:00 +08:00
used to hold application-specific data (that is, the form-
driver code leaves it alone). These functions get and set
the form user pointer field.
</PRE>
<H2>RETURN VALUE</H2><PRE>
The function <STRONG>form_userptr</STRONG> returns a pointer (which may be
2006-12-18 12:32:42 +08:00
<STRONG>NULL</STRONG>). It does not set errno.
1997-05-15 12:00:00 +08:00
2006-12-18 12:32:42 +08:00
The function <STRONG>set_form_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success).
1997-05-15 12:00:00 +08:00
</PRE>
<H2>SEE ALSO</H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
1997-05-15 12:00:00 +08:00
</PRE>
<H2>NOTES</H2><PRE>
2002-10-13 11:35:53 +08:00
The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
file <STRONG>&lt;curses.h&gt;</STRONG>.
1997-05-15 12:00:00 +08:00
</PRE>
<H2>PORTABILITY</H2><PRE>
These routines emulate the System V forms library. They
1997-05-15 12:00:00 +08:00
were not supported on Version 7 or BSD versions.
2006-12-18 12:32:42 +08:00
The user pointer is a void pointer. We chose not to leave
it as a char pointer for SVr4 compatibility.
1997-05-15 12:00:00 +08:00
</PRE>
<H2>AUTHORS</H2><PRE>
Juergen Pfeifer. Manual pages and adaptation for new
1997-05-15 12:00:00 +08:00
curses by Eric S. Raymond.
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
1997-05-15 12:00:00 +08:00
</PRE>
2000-07-09 10:46:08 +08:00
<HR>
Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a>
1997-05-15 12:00:00 +08:00
</BODY>
</HTML>