doc/html/man/mitem_userptr.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018,2020 Thomas E. Dickey                                     *
   5   * Copyright 1998-2010,2015 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: mitem_userptr.3x,v 1.17 2020/10/18 00:36:16 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>mitem_userptr 3x</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">mitem_userptr 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>                                            <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>set_item_userptr</STRONG>, <STRONG>item_userptr</STRONG> - associate application data with a menu
  52        item
  53
  54
  55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  57
  58        <STRONG>int</STRONG> <STRONG>set_item_userptr(ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>userptr</EM><STRONG>);</STRONG>
  59        <STRONG>void</STRONG> <STRONG>*item_userptr(const</STRONG> <STRONG>ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>);</STRONG>
  60
  61
  62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  63        Every menu item has a field that  can  be  used  to  hold  application-
  64        specific  data  (that is, the menu-driver code leaves it alone).  These
  65        functions get and set that field.
  66
  67
  68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  69        The function <STRONG>item_userptr</STRONG> returns a pointer (possibly <STRONG>NULL</STRONG>).   It  does
  70        not set <STRONG>errno</STRONG>.
  71
  72        The <STRONG>set_item_userptr</STRONG> always returns <STRONG>E_OK</STRONG> (success).
  73
  74
  75 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  76        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
  77
  78
  79 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  80        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
  81        <STRONG>&lt;curses.h&gt;</STRONG>.
  82
  83
  84 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  85        These routines emulate the  System  V  menu  library.   They  were  not
  86        supported on Version 7 or BSD versions.
  87
  88        The user pointer is a void pointer.  We chose not to leave it as a char
  89        pointer for SVr4 compatibility.
  90
  91
  92 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
  93        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
  94        Raymond.
  95
  96
  97
  98                                                              <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
  99 </PRE>
 100 <div class="nav">
 101 <ul>
 102 <li><a href="#h2-NAME">NAME</a></li>
 103 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 104 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 105 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 106 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 107 <li><a href="#h2-NOTES">NOTES</a></li>
 108 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 109 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 110 </ul>
 111 </div>
 112 </BODY>
 113 </HTML>