+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<!--
+ * t
+ ****************************************************************************
+ * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: menu_mark.3x,v 1.11 2010/12/04 18:40:45 tom Exp @
+-->
<HTML>
+<HEAD>
+<TITLE>menu_mark 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1>menu_mark 3x</H1>
+<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
+
+
+
</PRE>
<H2>NAME</H2><PRE>
- <B>menu_mark</B> - get and set the menu mark string
+ <STRONG>menu_mark</STRONG> - get and set the menu mark string
</PRE>
<H2>SYNOPSIS</H2><PRE>
- <B>#include</B> <B><menu.h></B>
+ <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
int set_menu_mark(MENU *menu, const char *mark);
const char *menu_mark(const MENU *menu);
library marks selected items in a menu with a prefix
string.
- The function <B>set_menu_mark</B> sets the mark string for the
- given menu. Calling <B>set_menu_mark</B> with a null menu item
+ The function <STRONG>set_menu_mark</STRONG> sets the mark string for the
+ given menu. Calling <STRONG>set_menu_mark</STRONG> with a null menu item
will abolish the mark string. Note that changing the
length of the mark string for a menu while the menu is
posted is likely to produce unhelpful behavior.
- The default string is "-" (a dash). Calling <B>set_menu_mark</B>
- with a <B>NULL</B> menu argument will change this default.
+ The default string is "-" (a dash). Calling <STRONG>set_menu_mark</STRONG>
+ with a non-<STRONG>NULL</STRONG> menu argument will change this default.
- The function <B>menu_mark</B> returns the menu's mark string (or
- <B>NULL</B> if there is none).
+ The function <STRONG>menu_mark</STRONG> returns the menu's mark string (or
+ <STRONG>NULL</STRONG> if there is none).
</PRE>
<H2>RETURN VALUE</H2><PRE>
- The function <B>menu_mark</B> returns <B>NULL</B> on error. The func-
- tion <B>set_menu_mark</B> may return the following error codes:
+ The function <STRONG>menu_mark</STRONG> returns a pointer (which may be
+ <STRONG>NULL</STRONG>). It does not set errno.
- <B>E_OK</B> The routine succeeded.
+ The function <STRONG>set_menu_mark</STRONG> may return the following error
+ codes:
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno</B>).
+ <STRONG>E_OK</STRONG> The routine succeeded.
- <B>E_BAD_ARGUMENT</B>
- Routine detected an incorrect or out-of-range argu-
+ <STRONG>E_BAD_ARGUMENT</STRONG>
+ Routine detected an incorrect or out-of-range argu-
ment.
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno</STRONG>).
+
</PRE>
<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
</PRE>
<H2>NOTES</H2><PRE>
- The header file <B><menu.h></B> automatically includes the header
- file <B><curses.h></B>.
+ The header file <STRONG><menu.h></STRONG> automatically includes the header
+ file <STRONG><curses.h></STRONG>.
</PRE>
<H2>PORTABILITY</H2><PRE>
- These routines emulate the System V menu library. They
+ These routines emulate the System V menu library. They
were not supported on Version 7 or BSD versions.
</PRE>
<H2>AUTHORS</H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
+ Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
+
+
+ <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
</PRE>
<HR>
<ADDRESS>
projects / ncurses.git / blobdiff