doc/html/man/form_userptr.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>form_userptr</B> - associate application data with a form item
   9
  10
  11 </PRE>
  12 <H2>SYNOPSIS</H2><PRE>
  13        <B>#include</B> <B>&lt;form.h&gt;</B>
  14        int set_form_userptr(FORM *form, void *userptr);
  15        void* form_userptr(const FORM *form);
  16
  17
  18 </PRE>
  19 <H2>DESCRIPTION</H2><PRE>
  20        Every form and every form item has a  field  that  can  be
  21        used to hold application-specific data (that is, the form-
  22        driver code leaves it alone).  These functions get and set
  23        the form user pointer field.
  24
  25
  26 </PRE>
  27 <H2>RETURN VALUE</H2><PRE>
  28        The  function  <B>form_userptr</B>  returns  <B>NULL</B>  on error.  The
  29        function <B>set_form_userptr</B> returns one of the following:
  30
  31        <B>E_OK</B> The routine succeeded.
  32
  33        <B>E_SYSTEM_ERROR</B>
  34             System error occurred (see <B>errno</B>).
  35
  36
  37 </PRE>
  38 <H2>SEE ALSO</H2><PRE>
  39        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
  40
  41
  42 </PRE>
  43 <H2>NOTES</H2><PRE>
  44        The header file <B>&lt;form.h&gt;</B> automatically includes the header
  45        file <B>&lt;curses.h&gt;</B>.
  46
  47
  48 </PRE>
  49 <H2>PORTABILITY</H2><PRE>
  50        These  routines  emulate the System V forms library.  They
  51        were not supported on Version 7 or BSD versions.
  52
  53        The user pointer should be a void pointer.  We leave it as
  54        a char pointer for SVr4 compatibility.
  55
  56
  57 </PRE>
  58 <H2>AUTHORS</H2><PRE>
  59        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
  60        curses by Eric S. Raymond.
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75 </PRE>
  76 <HR>
  77 <ADDRESS>
  78 Man(1) output converted with
  79 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  80 </ADDRESS>
  81 </BODY>
  82 </HTML>