ncurses 5.9 - patch 20150214
[ncurses.git] / doc / html / man / form_field_validation.3x.html
index 4dbed031ee7c745a7de8f425d9bceb05257ca6b6..d48d5d605a8a58769e60ebd0f9731e267412292f 100644 (file)
@@ -1,7 +1,6 @@
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
 <!-- 
   ****************************************************************************
 <!-- 
   ****************************************************************************
-  * Copyright (c) 1998-2003,2006 Free Software Foundation, Inc.              *
+  * 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            *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: form_field_validation.3x,v 1.15 2006/11/04 17:14:19 tom Exp @
+  * @Id: form_field_validation.3x,v 1.20 2010/12/04 18:38:55 tom Exp @
 -->
 -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <HTML>
 <HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
 <TITLE>form_field_validation 3x</TITLE>
 <link rev=made href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 <TITLE>form_field_validation 3x</TITLE>
 <link rev=made href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 <H1>form_field_validation 3x</H1>
 <HR>
 <PRE>
 <H1>form_field_validation 3x</H1>
 <HR>
 <PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
 <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>                     <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
 
 
 
 
 </PRE>
 <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>                     <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
 
 
 
 
 </PRE>
-<H2>NAME</H2><PRE>
+<H2><a name="h2-NAME">NAME</a></H2><PRE>
        <STRONG>form_field_validation</STRONG> - data type validation for fields
 
 
 </PRE>
        <STRONG>form_field_validation</STRONG> - data type validation for fields
 
 
 </PRE>
-<H2>SYNOPSIS</H2><PRE>
+<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
        int set_field_type(FIELD *field, FIELDTYPE *type, ...);
        FIELDTYPE *field_type(const FIELD *field);
        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
        int set_field_type(FIELD *field, FIELDTYPE *type, ...);
        FIELDTYPE *field_type(const FIELD *field);
@@ -67,7 +68,7 @@
 
 
 </PRE>
 
 
 </PRE>
-<H2>DESCRIPTION</H2><PRE>
+<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
        The  function  <STRONG>set_field_type</STRONG>  declares  a data type for a
        given form field.  This is the type checked by  validation
        functions.  The predefined types are as follows:
        The  function  <STRONG>set_field_type</STRONG>  declares  a data type for a
        given form field.  This is the type checked by  validation
        functions.  The predefined types are as follows:
             partial  match  must be a unique one (if this flag is
             off, a prefix matches the first of any  set  of  more
             than  one  list  elements  with  that prefix). Please
             partial  match  must be a unique one (if this flag is
             off, a prefix matches the first of any  set  of  more
             than  one  list  elements  with  that prefix). Please
-            notice that the string list is  not  copied,  only  a
-            reference to it is stored in the field. So you should
-            avoid using a list that lives in automatic  variables
-            on the stack.
+            notice that the string list is copied. So you may use
+            a  list  that  lives  in  automatic  variables on the
+            stack.
 
        TYPE_INTEGER
 
        TYPE_INTEGER
-            Integer  data,  parsable  to  an  integer by <STRONG>atoi(3)</STRONG>.
-            Requires a third <STRONG>int</STRONG> argument controlling the  preci-
-            sion,  a  fourth  <STRONG>long</STRONG>  argument constraining minimum
-            value, and a fifth <STRONG>long</STRONG> constraining  maximum  value.
-            If  the  maximum  value  is less than or equal to the
+            Integer data, parsable  to  an  integer  by  <STRONG>atoi(3)</STRONG>.
+            Requires  a third <STRONG>int</STRONG> argument controlling the preci-
+            sion, a fourth  <STRONG>long</STRONG>  argument  constraining  minimum
+            value,  and  a fifth <STRONG>long</STRONG> constraining maximum value.
+            If the maximum value is less than  or  equal  to  the
             minimum value, the range is simply ignored. On return
             the field buffer is formatted according to the <STRONG>printf</STRONG>
             minimum value, the range is simply ignored. On return
             the field buffer is formatted according to the <STRONG>printf</STRONG>
-            format  specification  ".*ld",  where  the   '*'   is
-            replaced  by  the precision argument.  For details of
+            format   specification   ".*ld",  where  the  '*'  is
+            replaced by the precision argument.  For  details  of
             the precision handling see <STRONG>printf's</STRONG> man-page.
 
        TYPE_NUMERIC
             the precision handling see <STRONG>printf's</STRONG> man-page.
 
        TYPE_NUMERIC
-            Numeric  data  (may  have  a   decimal-point   part).
-            Requires  a third <STRONG>int</STRONG> argument controlling the preci-
-            sion, a fourth <STRONG>double</STRONG> argument  constraining  minimum
+            Numeric   data   (may  have  a  decimal-point  part).
+            Requires a third <STRONG>int</STRONG> argument controlling the  preci-
+            sion,  a  fourth <STRONG>double</STRONG> argument constraining minimum
             value, and a fifth <STRONG>double</STRONG> constraining maximum value.
             value, and a fifth <STRONG>double</STRONG> constraining maximum value.
-            If your system supports locales,  the  decimal  point
-            character  to  be  used  must be the one specified by
-            your locale.  If the maximum value is  less  than  or
-            equal  to  the  minimum  value,  the  range is simply
-            ignored. On return  the  field  buffer  is  formatted
-            according  to  the <STRONG>printf</STRONG> format specification ".*f",
-            where the '*' is replaced by the precision  argument.
-            For  details  of  the precision handling see <STRONG>printf's</STRONG>
+            If  your  system  supports locales, the decimal point
+            character to be used must be  the  one  specified  by
+            your  locale.   If  the maximum value is less than or
+            equal to the  minimum  value,  the  range  is  simply
+            ignored.  On  return  the  field  buffer is formatted
+            according to the <STRONG>printf</STRONG> format  specification  ".*f",
+            where  the '*' is replaced by the precision argument.
+            For details of the precision  handling  see  <STRONG>printf's</STRONG>
             man-page.
 
        TYPE_REGEXP
             man-page.
 
        TYPE_REGEXP
-            Regular expression data.  Requires a regular  expres-
-            sion  <STRONG>(char</STRONG>  <STRONG>*)</STRONG>  third argument; the data is valid if
-            the regular expression matches it.   Regular  expres-
-            sions   are   in   the   format  of  <STRONG><A HREF="regcomp.3x.html">regcomp(3x)</A></STRONG>  and
-            <STRONG><A HREF="regexec.3x.html">regexec(3x)</A></STRONG>. Please notice that the  regular  expres-
-            sion  must  match  the  whole  field. If you have for
-            example an eight  character  wide  field,  a  regular
-            expression  "^[0-9]*$"  always means that you have to
-            fill all eight positions with digits. If you want  to
-            allow  fewer digits, you may use for example "^[0-9]*
-            *$" which is good for trailing spaces (up to an empty
-            field),  or  "^ *[0-9]* *$" which is good for leading
-            and trailing spaces around the digits.
+            Regular  expression data.  Requires a regular expres-
+            sion <STRONG>(char</STRONG> <STRONG>*)</STRONG> third argument; the data  is  valid  if
+            the  regular  expression matches it.  Regular expres-
+            sions are in  the  format  of  <STRONG>regcomp</STRONG>  and  <STRONG>regexec</STRONG>.
+            Please  notice that the regular expression must match
+            the whole field. If you have  for  example  an  eight
+            character wide field, a regular expression "^[0-9]*$"
+            always means that you have to fill  all  eight  posi-
+            tions with digits. If you want to allow fewer digits,
+            you may use for example "^[0-9]* *$"  which  is  good
+            for  trailing  spaces  (up  to an empty field), or "^
+            *[0-9]* *$" which is good for  leading  and  trailing
+            spaces around the digits.
 
        TYPE_IPV4
             An Internet Protocol Version 4 address. This requires
 
        TYPE_IPV4
             An Internet Protocol Version 4 address. This requires
-            no  additional argument. It is checked whether or not
-            the buffer has the form a.b.c.d, where  a,b,c  and  d
+            no additional argument. It is checked whether or  not
+            the  buffer  has  the form a.b.c.d, where a,b,c and d
             are numbers between 0 and 255. Trailing blanks in the
             are numbers between 0 and 255. Trailing blanks in the
-            buffer are ignored. The address itself is  not  vali-
+            buffer  are  ignored. The address itself is not vali-
             dated. Please note that this is an ncurses extension.
             dated. Please note that this is an ncurses extension.
-            This field type may not be available in other  curses
+            This  field type may not be available in other curses
             implementations.
 
             implementations.
 
-       It  is  possible  to  set  up new programmer-defined field
+       It is possible to  set  up  new  programmer-defined  field
        types.  See the <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> manual page.
 
 
 </PRE>
        types.  See the <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> manual page.
 
 
 </PRE>
-<H2>RETURN VALUE</H2><PRE>
-       The functions <STRONG>field_type</STRONG>  and  <STRONG>field_arg</STRONG>  return  <STRONG>NULL</STRONG>  on
+<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+       The  functions  <STRONG>field_type</STRONG>  and  <STRONG>field_arg</STRONG>  return <STRONG>NULL</STRONG> on
        error. The function <STRONG>set_field_type</STRONG> returns one of the fol-
        lowing:
 
        error. The function <STRONG>set_field_type</STRONG> returns one of the fol-
        lowing:
 
 
 
 </PRE>
 
 
 </PRE>
-<H2>SEE ALSO</H2><PRE>
-       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
+<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>.
 
 
 </PRE>
 
 
 </PRE>
-<H2>NOTES</H2><PRE>
+<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
        file <STRONG>&lt;curses.h&gt;</STRONG>.
 
 
 </PRE>
        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
        file <STRONG>&lt;curses.h&gt;</STRONG>.
 
 
 </PRE>
-<H2>PORTABILITY</H2><PRE>
-       These  routines  emulate the System V forms library.  They
+<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+       These routines emulate the System V forms  library.   They
        were not supported on Version 7 or BSD versions.
 
 
 </PRE>
        were not supported on Version 7 or BSD versions.
 
 
 </PRE>
-<H2>AUTHORS</H2><PRE>
-       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
+<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
+       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
        curses by Eric S. Raymond.
 
 
 
                                               <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
 </PRE>
        curses by Eric S. Raymond.
 
 
 
                                               <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
 </PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-AUTHORS">AUTHORS</a></li>
+</ul>
+</div>
 </BODY>
 </HTML>
 </BODY>
 </HTML>