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

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: form_userptr.3x,v 1.14 2015/12/05 23:42:45 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>form_userptr 3x</TITLE>
  38 <link rev=made href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">form_userptr 3x</H1>
  43 <PRE>
  44 <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>                                       <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>set_form_userptr</STRONG>,  <STRONG>form_userptr</STRONG>  -  associate  application
  51        data with a form item
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  56        int set_form_userptr(FORM *form, void *userptr);
  57        void* form_userptr(const FORM *form);
  58
  59
  60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  61        Every form and every form item has a  field  that  can  be
  62        used to hold application-specific data (that is, the form-
  63        driver code leaves it alone).  These functions get and set
  64        the form user pointer field.
  65
  66
  67 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  68        The  function <STRONG>form_userptr</STRONG> returns a pointer (which may be
  69        <STRONG>NULL</STRONG>).  It does not set errno.
  70
  71        The function <STRONG>set_form_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success).
  72
  73
  74 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  75        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
  76
  77
  78 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  79        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
  80        file <STRONG>&lt;curses.h&gt;</STRONG>.
  81
  82
  83 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  84        These  routines  emulate the System V forms library.  They
  85        were not supported on Version 7 or BSD versions.
  86
  87        The user pointer is a void pointer.  We chose not to leave
  88        it as a char pointer for SVr4 compatibility.
  89
  90
  91 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
  92        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
  93        curses by Eric S. Raymond.
  94
  95
  96
  97                                                        <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
  98 </PRE>
  99 <div class="nav">
 100 <ul>
 101 <li><a href="#h2-NAME">NAME</a></li>
 102 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 103 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 104 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 105 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 106 <li><a href="#h2-NOTES">NOTES</a></li>
 107 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 108 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 109 </ul>
 110 </div>
 111 </BODY>
 112 </HTML>