ncurses 5.7 - patch 20110108
[ncurses.git] / doc / html / man / menu_mark.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998-2006,2010 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_mark.3x,v 1.11 2010/12/04 18:40:45 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>menu_mark 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_mark 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44 <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>                                             <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2>NAME</H2><PRE>
51        <STRONG>menu_mark</STRONG> - get and set the menu mark string
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        int set_menu_mark(MENU *menu, const char *mark);
58        const char *menu_mark(const MENU *menu);
59
60
61 </PRE>
62 <H2>DESCRIPTION</H2><PRE>
63        In  order  to make menu selections visible on older termi-
64        nals without highlighting or color  capability,  the  menu
65        library  marks  selected  items  in  a  menu with a prefix
66        string.
67
68        The function <STRONG>set_menu_mark</STRONG> sets the mark  string  for  the
69        given  menu.   Calling <STRONG>set_menu_mark</STRONG> with a null menu item
70        will abolish the mark  string.   Note  that  changing  the
71        length  of  the  mark  string for a menu while the menu is
72        posted is likely to produce unhelpful behavior.
73
74        The default string is "-" (a dash). Calling  <STRONG>set_menu_mark</STRONG>
75        with a non-<STRONG>NULL</STRONG> menu argument will change this default.
76
77        The  function <STRONG>menu_mark</STRONG> returns the menu's mark string (or
78        <STRONG>NULL</STRONG> if there is none).
79
80
81 </PRE>
82 <H2>RETURN VALUE</H2><PRE>
83        The function <STRONG>menu_mark</STRONG> returns a  pointer  (which  may  be
84        <STRONG>NULL</STRONG>).  It does not set errno.
85
86        The  function <STRONG>set_menu_mark</STRONG> may return the following error
87        codes:
88
89        <STRONG>E_OK</STRONG> The routine succeeded.
90
91        <STRONG>E_BAD_ARGUMENT</STRONG>
92             Routine detected an incorrect or  out-of-range  argu-
93             ment.
94
95        <STRONG>E_SYSTEM_ERROR</STRONG>
96             System error occurred (see <STRONG>errno</STRONG>).
97
98
99 </PRE>
100 <H2>SEE ALSO</H2><PRE>
101        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
102
103
104 </PRE>
105 <H2>NOTES</H2><PRE>
106        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
107        file <STRONG>&lt;curses.h&gt;</STRONG>.
108
109
110 </PRE>
111 <H2>PORTABILITY</H2><PRE>
112        These routines emulate the System V  menu  library.   They
113        were not supported on Version 7 or BSD versions.
114
115
116 </PRE>
117 <H2>AUTHORS</H2><PRE>
118        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
119        curses by Eric S. Raymond.
120
121
122
123                                                           <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
124 </PRE>
125 <HR>
126 <ADDRESS>
127 Man(1) output converted with
128 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
129 </ADDRESS>
130 </BODY>
131 </HTML>