man7.org > Linux > man-pages

Linux/UNIX system programming training

menu_mark(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | NOTES | PORTABILITY | AUTHORS | COLOPHON 

menu_mark(3X)                                              menu_mark(3X)

NAME         top

       set_menu_mark, menu_mark - get and set the menu mark string

SYNOPSIS         top

       #include <menu.h>

       int set_menu_mark(MENU *menu, const char *mark);
       const char *menu_mark(const MENU *menu);

DESCRIPTION         top

       In order to make menu selections visible on older terminals
       without highlighting or color capability, the menu library marks
       selected items in a menu with a prefix string.

       The function set_menu_mark sets the mark string for the given
       menu.  Calling set_menu_mark 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 set_menu_mark with a
       non-NULL menu argument will change this default.

       The function menu_mark returns the menu's mark string (or NULL if
       there is none).

RETURN VALUE         top

       The function menu_mark returns a pointer (which may be NULL).  It
       does not set errno.

       The function set_menu_mark may return the following error codes:

       E_OK The routine succeeded.

       E_BAD_ARGUMENT
            Routine detected an incorrect or out-of-range argument.

       E_SYSTEM_ERROR
            System error occurred (see errno(3)).

SEE ALSO         top

       curses(3X), menu(3X).

NOTES         top

       The header file <menu.h> automatically includes the header file
       <curses.h>.

PORTABILITY         top

       These routines emulate the System V menu library.  They were not
       supported on Version 7 or BSD versions.

AUTHORS         top

       Juergen Pfeifer.  Manual pages and adaptation for new curses by
       Eric S. Raymond.

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have
       a bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨https://github.com/mirror/ncurses.git⟩ on 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-03-12.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                                           menu_mark(3X)

HTML rendering created 2023-12-22 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI