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

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 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: mitem_userptr.3x,v 1.34 2024/03/16 15:35:01 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 https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>mitem_userptr 3x 2024-03-16 ncurses 6.4 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">mitem_userptr 3x 2024-03-16 ncurses 6.4 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>                Library calls               <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>set_item_userptr</STRONG>, <STRONG>item_userptr</STRONG> - associate application data with a menu
  51        item
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  56
  57        <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>
  58        <STRONG>void</STRONG> <STRONG>*item_userptr(const</STRONG> <STRONG>ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>);</STRONG>
  59
  60
  61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  62        Every menu item has a field that  can  be  used  to  hold  application-
  63        specific  data  (that is, the menu-driver code leaves it alone).  These
  64        functions get and set that field.
  65
  66
  67 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  68        The function <STRONG>item_userptr</STRONG> returns a pointer (possibly <STRONG>NULL</STRONG>).   It  does
  69        not set <STRONG>errno</STRONG>.
  70
  71        The <STRONG>set_item_userptr</STRONG> always returns <STRONG>E_OK</STRONG> (success).
  72
  73
  74 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  75        These  routines  emulate  the  System  V  menu  library.  They were not
  76        supported on Version 7 or BSD versions.
  77
  78        The user pointer is a void pointer.  We chose not to leave it as a char
  79        pointer for SVr4 compatibility.
  80
  81
  82 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
  83        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
  84        Raymond.
  85
  86
  87 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  88        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
  89
  90
  91
  92 ncurses 6.4                       2024-03-16                 <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
  93 </PRE>
  94 <div class="nav">
  95 <ul>
  96 <li><a href="#h2-NAME">NAME</a></li>
  97 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
  98 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
  99 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 100 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 101 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 102 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 103 </ul>
 104 </div>
 105 </BODY>
 106 </HTML>