ncursesw-morphos/Ada95/html/form_userptr.3x.html

73 lines
1.7 KiB
HTML
Raw Normal View History

1997-05-15 12:00:00 +08:00
<HTML>
<BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
<PRE>
<STRONG>form_userptr</STRONG> - associate application data with a form item
</PRE>
<H2>SYNOPSIS</H2><PRE>
<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
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 <STRONG>NULL</STRONG> on error. The
function <STRONG>set_form_userptr</STRONG> returns one of the following:
<STRONG>E_OK</STRONG> The routine succeeded.
<STRONG>E_SYSTEM_ERROR</STRONG>
System error occurred (see <STRONG>errno</STRONG>).
</PRE>
<H2>SEE ALSO</H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
</PRE>
<H2>NOTES</H2><PRE>
The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
file <STRONG>&lt;curses.h&gt;</STRONG>.
</PRE>
<H2>PORTABILITY</H2><PRE>
These routines emulate the System V forms library. They
were not supported on Version 7 or BSD versions.
The user pointer should be a void pointer. We leave it as
a char pointer for SVr4 compatibility.
</PRE>
<H2>AUTHORS</H2><PRE>
Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
</PRE>
</BODY>
</HTML>