ncurses 5.6

[ncurses.git] / doc / html / man / menu_pattern.3x.html
diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html

index 431787c9baa6431ba070479c623cec2f93660208..e39be1ed29c0b67f7c095f13b02e7523c0be3000 100644 (file)
--- a/doc/html/man/menu_pattern.3x.html
+++ b/doc/html/man/menu_pattern.3x.html
@@ -1,7 +1,7 @@
  <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  <!-- 
    ****************************************************************************
-  * Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
+  * Copyright (c) 1998-2003,2006 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            *
@@ -27,7 +27,7 @@
    * sale, use or other dealings in this Software without prior written       *
    * authorization.                                                           *
    ****************************************************************************
-  * @Id: menu_pattern.3x,v 1.8 2003/05/10 20:22:01 tom Exp @
+  * @Id: menu_pattern.3x,v 1.10 2006/11/04 18:25:24 tom Exp @
  -->
  <HTML>
  <HEAD>
@@ -75,22 +75,33 @@
  
  </PRE>
  <H2>RETURN VALUE</H2><PRE>
-       The function <STRONG>menu_pattern</STRONG>  returns  <STRONG>NULL</STRONG>  on  error.   The
-       function  <STRONG>set_menu_pattern</STRONG>  may return the following error
-       codes:
+       The function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG>
+       if the <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.  Otherwise, it is a pointer
+       to a string which is empty if no pattern has been set.  It
+       does not set errno.
  
-       <STRONG>E_OK</STRONG> The routine succeeded.
+       The  function  <STRONG>set_menu_pattern</STRONG>  may  return the following
+       error codes:
  
-       <STRONG>E_SYSTEM_ERROR</STRONG>
-            System error occurred (see <STRONG>errno</STRONG>).
+       <STRONG>E_OK</STRONG> The routine succeeded.
  
         <STRONG>E_BAD_ARGUMENT</STRONG>
              Routine detected an incorrect or  out-of-range  argu-
              ment.
  
+       <STRONG>E_BAD_STATE</STRONG>
+            Routine was called from an initialization or termina-
+            tion function.
+
+       <STRONG>E_NOT_CONNECTED</STRONG>
+            No items are connected to menu.
+
         <STRONG>E_NO_MATCH</STRONG>
              Character failed to match.
  
+       <STRONG>E_SYSTEM_ERROR</STRONG>
+            System error occurred (see <STRONG>errno</STRONG>).
+
  
  </PRE>
  <H2>SEE ALSO</H2><PRE>
@@ -105,13 +116,13 @@
  
  </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.