usr/src/man/man3curses/form_field_validation.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH FORM_FIELD_VALIDATION 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_field_validation, set_field_type, field_type, field_arg \- forms field
  10 data type validation
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  15 #include <form.h>
  16
  17 \fBint\fR \fBset_field_type\fR(\fBFIELD *\fR\fIfield\fR, \fBFIELDTYPE *\fR\fItype\fR...);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBFIELDTYPE *\fR\fBfield_type\fR(\fBFIELD *\fR\fIfield\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBchar *\fR\fBfield_arg\fR(\fBFIELD *\fR\fIfield\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 \fBset_field_type()\fR associates the specified field type with \fIfield\fR.
  34 Certain field types take additional arguments. \fBTYPE_ALNUM\fR, for instance,
  35 requires one, the minimum width specification for the field. The other
  36 predefined field types are: \fBTYPE_ALPHA\fR, \fBTYPE_ENUM\fR,
  37 \fBTYPE_INTEGER\fR, \fBTYPE_NUMERIC\fR, and \fBTYPE_REGEXP\fR.
  38 .sp
  39 .LP
  40 \fBfield_type()\fR returns a pointer to the field type of \fIfield\fR.
  41 \fINULL\fR is returned if no field type is assigned.
  42 .sp
  43 .LP
  44 \fBfield_arg()\fR returns a pointer to the field arguments associated with the
  45 field type of \fIfield\fR. \fINULL\fR is returned if no field type is assigned.
  46 .SH RETURN VALUES
  47 .sp
  48 .LP
  49 \fBfield_type()\fR and \fBfield_arg()\fR return \fINULL\fR on error.
  50 .sp
  51 .LP
  52 \fBset_field_type()\fR returns one of the following:
  53 .sp
  54 .ne 2
  55 .na
  56 \fBE_OK\fR
  57 .ad
  58 .RS 18n
  59 The function returned successfully.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fBE_SYSTEM_ERROR\fR
  66 .ad
  67 .RS 18n
  68 System error.
  69 .RE
  70
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 MT-Level        Unsafe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
  91 .SH NOTES
  92 .sp
  93 .LP
  94 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
  95 \fB<curses.h>\fR\&.