ncurses 5.6 - patch 20080621

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

index c23ac00396c8f23f0511d1e4599ef6044c4854ec..8e99806ddbf31890f6f2e176c747c7f0f4ab09db 100644 (file)
--- a/doc/html/man/form_field_buffer.3x.html
+++ b/doc/html/man/form_field_buffer.3x.html
@@ -2,7 +2,7 @@
  <!-- 
    * t
    ****************************************************************************
-  * Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
+  * Copyright (c) 1998-2005,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            *
@@ -28,7 +28,7 @@
    * sale, use or other dealings in this Software without prior written       *
    * authorization.                                                           *
    ****************************************************************************
-  * @Id: form_field_buffer.3x,v 1.9 2002/01/19 22:48:23 tom Exp @
+  * @Id: form_field_buffer.3x,v 1.14 2006/11/04 17:12:00 tom Exp @
  -->
  <HTML>
  <HEAD>
@@ -41,6 +41,10 @@
  <HR>
  <PRE>
  <!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>                             <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
+
+
+
  
  </PRE>
  <H2>NAME</H2><PRE>
@@ -74,7 +78,7 @@
         value out of the buffer and removes the leading and trail-
         ing spaces. Please note also, that  subsequent  operations
         on  the  form  will  probably  change  the  content of the
-       buffer. So don't use it  for  long  term  storage  of  the
+       buffer. So do not use it for  long  term  storage  of  the
         entered form data.
  
         The  function  <STRONG>set_field_status</STRONG> sets the associated status
@@ -89,7 +93,14 @@
  
  </PRE>
  <H2>RETURN VALUE</H2><PRE>
-       The <STRONG>field_buffer</STRONG> function returns NULL on error.
+       The <STRONG>field_buffer</STRONG> function returns NULL on error.  It  sets
+       errno according to their success:
+
+       <STRONG>E_OK</STRONG> The routine succeeded.
+
+       <STRONG>E_BAD_ARGUMENT</STRONG>
+            Routine  detected  an incorrect or out-of-range argu-
+            ment.
  
         The <STRONG>field_status</STRONG> function returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
  
@@ -114,7 +125,13 @@
  </PRE>
  <H2>NOTES</H2><PRE>
         The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
-       file <STRONG>&lt;curses.h&gt;</STRONG>.
+       file
+
+       When  configured for wide-characters, <STRONG>field_buffer</STRONG> returns
+       a pointer to temporary storage (allocated and freed by the
+       library).   The  application  should not attempt to modify
+       the  data.   It  will  be  freed  on  the  next  call   to
+       <STRONG>field_buffer</STRONG> to return the same buffer.  <STRONG>&lt;curses.h&gt;</STRONG>.
  
  
  </PRE>
@@ -130,42 +147,7 @@
  
  
  
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+                                                  <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
  </PRE>
  <HR>
  <ADDRESS>