menu_items.3x.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  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: menu_items.3x,v 1.7 2006/11/04 18:35:31 tom Exp @
  32. -->
  33. <HTML>
  34. <HEAD>
  35. <TITLE>menu_items 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>menu_items 3x</H1>
  41. <HR>
  42. <PRE>
  43. <!-- Manpage converted by man2html 3.0.1 -->
  44. <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG> <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
  45. </PRE>
  46. <H2>NAME</H2><PRE>
  47. <STRONG>menu_items</STRONG> - make and break connections between items and
  48. menus
  49. </PRE>
  50. <H2>SYNOPSIS</H2><PRE>
  51. <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  52. int set_menu_items(MENU *menu, ITEM **items);
  53. ITEM **menu_items(const MENU *menu);
  54. int item_count(const MENU *menu);
  55. </PRE>
  56. <H2>DESCRIPTION</H2><PRE>
  57. The function <STRONG>set_menu_items</STRONG> changes the item pointer array
  58. of the given <EM>menu</EM>. The array must be terminated by a
  59. <STRONG>NULL</STRONG>.
  60. The function <STRONG>menu_items</STRONG> returns the item array of the
  61. given menu.
  62. The function <STRONG>item_count</STRONG> returns the count of items in
  63. <EM>menu</EM>.
  64. </PRE>
  65. <H2>RETURN VALUES</H2><PRE>
  66. The function <STRONG>menu_items</STRONG> returns a pointer (which may be
  67. <STRONG>NULL</STRONG>). It does not set errno.
  68. The function <STRONG>item_count</STRONG> returns <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG>
  69. error return value) if its <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.
  70. The function <STRONG>set_menu_items</STRONG> returns one of the following
  71. codes on error:
  72. <STRONG>E_OK</STRONG> The routine succeeded.
  73. <STRONG>E_BAD_ARGUMENT</STRONG>
  74. Routine detected an incorrect or out-of-range argu-
  75. ment.
  76. <STRONG>E_NOT_CONNECTED</STRONG>
  77. No items are connected to the menu.
  78. <STRONG>E_POSTED</STRONG>
  79. The menu is already posted.
  80. <STRONG>E_SYSTEM_ERROR</STRONG>
  81. System error occurred (see <STRONG>errno</STRONG>).
  82. </PRE>
  83. <H2>SEE ALSO</H2><PRE>
  84. <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
  85. </PRE>
  86. <H2>NOTES</H2><PRE>
  87. The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
  88. file <STRONG>&lt;curses.h&gt;</STRONG>.
  89. </PRE>
  90. <H2>PORTABILITY</H2><PRE>
  91. These routines emulate the System V menu library. They
  92. were not supported on Version 7 or BSD versions.
  93. The SVr4 menu library documentation specifies the
  94. <STRONG>item_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
  95. </PRE>
  96. <H2>AUTHORS</H2><PRE>
  97. Juergen Pfeifer. Manual pages and adaptation for new
  98. curses by Eric S. Raymond.
  99. <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG>
  100. </PRE>
  101. <HR>
  102. <ADDRESS>
  103. Man(1) output converted with
  104. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  105. </ADDRESS>
  106. </BODY>
  107. </HTML>