ncurses 5.7 - patch 20110115

[ncurses.git] / man / menu_pattern.3x

diff --git a/man/menu_pattern.3x b/man/menu_pattern.3x
index 693ebe35729a25f3b0ecfd57e323ae2198f69fa2..e63a9f73d84c5f948aec8a939ec563d6bd63d705 100644 (file)
--- a/man/menu_pattern.3x
+++ b/man/menu_pattern.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2008,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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,10 +26,10 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.'" $Id: menu_pattern.3x,v 1.5 1998/03/11 21:12:53 juergen Exp $
+.\" $Id: menu_pattern.3x,v 1.13 2010/12/04 18:40:45 tom Exp $

 .TH menu_pattern 3X ""
 .SH NAME
 .TH menu_pattern 3X ""
 .SH NAME

-\fBmenu_pattern\fR - get and set a menu's pattern buffer
+\fBmenu_pattern\fR \- get and set a menu's pattern buffer

 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br


@@ -39,30 +39,39 @@ char *menu_pattern(const MENU *menu);
 .br
 .SH DESCRIPTION
 Every menu has an associated pattern match buffer.  As input events that are
 .br
 .SH DESCRIPTION
 Every menu has an associated pattern match buffer.  As input events that are

-printable ASCII characters come in, they are appended to this match buffer
+printable characters come in, they are appended to this match buffer

 and tested for a match, as described in \fBmenu_driver\fR(3X).
 and tested for a match, as described in \fBmenu_driver\fR(3X).

-
+.PP

 The function \fBset_menu_pattern\fR sets the pattern buffer for the given menu
 and tries to find the first matching item.  If it succeeds, that item becomes
 The function \fBset_menu_pattern\fR sets the pattern buffer for the given menu
 and tries to find the first matching item.  If it succeeds, that item becomes

-current; if not, the current item does not change.  
-
+current; if not, the current item does not change. 
+.PP

 The function \fBmenu_pattern\fR returns the pattern buffer of the given
 \fImenu\fR.
 .SH RETURN VALUE
 The function \fBmenu_pattern\fR returns the pattern buffer of the given
 \fImenu\fR.
 .SH RETURN VALUE

-The function \fBmenu_pattern\fR returns \fBNULL\fR on error.  The function
-\fBset_menu_pattern\fR may return the following error codes:
+The function \fBmenu_pattern\fR returns a pointer, which is \fBNULL\fR if the \fImenu\fP parameter is \fBNULL\fP.
+Otherwise, it is a pointer to a string which is empty if no pattern has been set.
+It does not set errno.
+.PP
+The function \fBset_menu_pattern\fR may return the following error codes:

 .TP 5
 .TP 5

-\fBE_OK\fR
+.B E_OK

 The routine succeeded.
 .TP 5
 The routine succeeded.
 .TP 5

-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
-.TP 5
-\fBE_BAD_ARGUMENT\fR
+.B E_BAD_ARGUMENT

 Routine detected an incorrect or out-of-range argument.
 .TP 5
 Routine detected an incorrect or out-of-range argument.
 .TP 5

-\fBE_NO_MATCH\fR
+.B E_BAD_STATE
+Routine was called from an initialization or termination function.
+.TP 5
+.B E_NOT_CONNECTED
+No items are connected to menu.
+.TP 5
+.B E_NO_MATCH

 Character failed to match.
 Character failed to match.

+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fR).

 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
 .SH NOTES
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
 .SH NOTES


@@ -74,9 +83,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: