ncurses 4.2
[ncurses.git] / Ada95 / html / menu_mark.3x.html
1 <HTML>
2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
3 <PRE>
4        <STRONG>menu_mark</STRONG> - get and set the menu mark string
5
6
7 </PRE>
8 <H2>SYNOPSIS</H2><PRE>
9        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
10        int set_menu_mark(MENU *menu, const char *mark);
11        const char *menu_mark(const MENU *menu);
12
13
14 </PRE>
15 <H2>DESCRIPTION</H2><PRE>
16        In  order  to make menu selections visible on older termi-
17        nals without highlighting or color  capability,  the  menu
18        library  marks  selected  items  in  a  menu with a prefix
19        string.
20
21        The function <STRONG>set_menu_mark</STRONG> sets the mark  string  for  the
22        given  menu.   Calling <STRONG>set_menu_mark</STRONG> with a null menu item
23        will abolish the mark  string.   Note  that  changing  the
24        length  of  the  mark  string for a menu while the menu is
25        posted is likely to produce unhelpful behavior.
26
27        The default string is "-" (a dash). Calling  <STRONG>set_menu_mark</STRONG>
28        with a <STRONG>NULL</STRONG> menu argument will change this default.
29
30        The  function <STRONG>menu_mark</STRONG> returns the menu's mark string (or
31        <STRONG>NULL</STRONG> if there is none).
32
33
34 </PRE>
35 <H2>RETURN VALUE</H2><PRE>
36        The function <STRONG>menu_mark</STRONG> returns <STRONG>NULL</STRONG> on error.   The  func-
37        tion <STRONG>set_menu_mark</STRONG> may return the following error codes:
38
39        <STRONG>E_OK</STRONG> The routine succeeded.
40
41        <STRONG>E_SYSTEM_ERROR</STRONG>
42             System error occurred (see <STRONG>errno</STRONG>).
43
44        <STRONG>E_BAD_ARGUMENT</STRONG>
45             Routine  detected  an incorrect or out-of-range argu-
46             ment.
47
48
49 </PRE>
50 <H2>SEE ALSO</H2><PRE>
51        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3X)</A></STRONG>.
52
53
54 </PRE>
55 <H2>NOTES</H2><PRE>
56        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
57        file <STRONG>&lt;curses.h&gt;</STRONG>.
58
59
60 </PRE>
61 <H2>PORTABILITY</H2><PRE>
62        These  routines  emulate  the System V menu library.  They
63        were not supported on Version 7 or BSD versions.
64
65
66 </PRE>
67 <H2>AUTHORS</H2><PRE>
68        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
69        curses by Eric S. Raymond.
70 </PRE>
71 </BODY>
72 </HTML>