doc/html/man/form_field_userptr.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   * t
   4   ****************************************************************************
   5   * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
   6   *                                                                          *
   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:                 *
  14   *                                                                          *
  15   * The above copyright notice and this permission notice shall be included  *
  16   * in all copies or substantial portions of the Software.                   *
  17   *                                                                          *
  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.                               *
  25   *                                                                          *
  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       *
  29   * authorization.                                                           *
  30   ****************************************************************************
  31   * @Id: form_field_userptr.3x,v 1.9 2010/07/31 16:09:36 tom Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>form_field_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">
  38 </HEAD>
  39 <BODY>
  40 <H1>form_field_userptr 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44 <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>                           <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2>NAME</H2><PRE>
  51        <STRONG>form_field_userptr</STRONG>  -  associate  application  data with a
  52        form field
  53
  54
  55 </PRE>
  56 <H2>SYNOPSIS</H2><PRE>
  57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  58        int set_field_userptr(FIELD *field, void*userptr);
  59        void *field_userptr(const FIELD *field);
  60
  61
  62 </PRE>
  63 <H2>DESCRIPTION</H2><PRE>
  64        Every form field has a field that  can  be  used  to  hold
  65        application-specific  data  (that is, the form-driver code
  66        leaves it alone).  These functions get and set that field.
  67
  68
  69 </PRE>
  70 <H2>RETURN VALUE</H2><PRE>
  71        The function <STRONG>field_userptr</STRONG> returns a pointer (which may be
  72        <STRONG>NULL</STRONG>).  It does not set errno.
  73
  74        The function <STRONG>set_field_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success).
  75
  76
  77 </PRE>
  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>.
  80
  81
  82 </PRE>
  83 <H2>NOTES</H2><PRE>
  84        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
  85        file <STRONG>&lt;curses.h&gt;</STRONG>.
  86
  87
  88 </PRE>
  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.
  92
  93        The user pointer is a void pointer.  We chose not to leave
  94        it as a char pointer for SVr4 compatibility.
  95
  96
  97 </PRE>
  98 <H2>AUTHORS</H2><PRE>
  99        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
 100        curses by Eric S. Raymond.
 101
 102
 103
 104                                                  <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>
 105 </PRE>
 106 <HR>
 107 <ADDRESS>
 108 Man(1) output converted with
 109 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 110 </ADDRESS>
 111 </BODY>
 112 </HTML>