blob: 4ac76f8bbe5171f1b890a19ce77b4799d75a5b91 (
plain) (
tree)
|
|
<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
</PRE>
<H2>NAME</H2><PRE>
<B>form_userptr</B> - associate application data with a form item
</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>#include</B> <B><form.h></B>
int set_form_userptr(FORM *form, void *userptr);
void* form_userptr(const FORM *form);
</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 <B>form_userptr</B> returns <B>NULL</B> on error. The
function <B>set_form_userptr</B> returns one of the following:
<B>E_OK</B> The routine succeeded.
<B>E_SYSTEM_ERROR</B>
System error occurred (see <B>errno</B>).
</PRE>
<H2>SEE ALSO</H2><PRE>
<B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
</PRE>
<H2>NOTES</H2><PRE>
The header file <B><form.h></B> automatically includes the header
file <B><curses.h></B>.
</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>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>
|
