mitem_userptr.3x.html 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  2. <!--
  3. * t
  4. ****************************************************************************
  5. * Copyright (c) 1998,2006 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.9 2006/11/04 18:21:03 tom Exp @
  32. -->
  33. <HTML>
  34. <HEAD>
  35. <TITLE>mitem_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>mitem_userptr 3x</H1>
  41. <HR>
  42. <PRE>
  43. <!-- Manpage converted by man2html 3.0.1 -->
  44. <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG> <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
  45. </PRE>
  46. <H2>NAME</H2><PRE>
  47. <STRONG>mitem_userptr</STRONG> - associate application data with a menu
  48. item
  49. </PRE>
  50. <H2>SYNOPSIS</H2><PRE>
  51. <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  52. int set_item_userptr(ITEM *item, void *userptr);
  53. void *item_userptr(const ITEM *item);
  54. </PRE>
  55. <H2>DESCRIPTION</H2><PRE>
  56. Every menu item has a field that can be used to hold
  57. application-specific data (that is, the menu-driver code
  58. leaves it alone). These functions get and set that field.
  59. </PRE>
  60. <H2>RETURN VALUE</H2><PRE>
  61. The function <STRONG>item_userptr</STRONG> returns a pointer (possibly
  62. <STRONG>NULL</STRONG>). It does not set errno.
  63. The <STRONG>set_item_userptr</STRONG> always returns <STRONG>E_OK</STRONG> (success).
  64. </PRE>
  65. <H2>SEE ALSO</H2><PRE>
  66. <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
  67. </PRE>
  68. <H2>NOTES</H2><PRE>
  69. The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
  70. file <STRONG>&lt;curses.h&gt;</STRONG>.
  71. </PRE>
  72. <H2>PORTABILITY</H2><PRE>
  73. These routines emulate the System V menu library. They
  74. were not supported on Version 7 or BSD versions.
  75. The user pointer is a void pointer. We chose not to leave
  76. it as a char pointer for SVr4 compatibility.
  77. </PRE>
  78. <H2>AUTHORS</H2><PRE>
  79. Juergen Pfeifer. Manual pages and adaptation for new
  80. curses by Eric S. Raymond.
  81. <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG>
  82. </PRE>
  83. <HR>
  84. <ADDRESS>
  85. Man(1) output converted with
  86. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  87. </ADDRESS>
  88. </BODY>
  89. </HTML>