1.\" $NetBSD: form_field_validation.3,v 1.4 2002/02/20 11:30:58 wiz Exp $ 2.\" 3.\" Copyright (c) 2001 4.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5.\" 6.\" This code is donated to The NetBSD Foundation by the author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd January 1, 2001 33.Dt FORMS 3 34.Os 35.Sh NAME 36.Nm field_arg , 37.Nm field_type , 38.Nm set_field_type 39.Nd form library 40.Sh LIBRARY 41.Lb libform 42.Sh SYNOPSIS 43.Fd #include \*[Lt]form.h\*[Gt] 44.Ft char * 45.Fn field_arg "FIELD *field" 46.Ft FIELDTYPE * 47.Fn field_type "FIELD *field" 48.Ft int 49.Fn set_field_type "FIELD *field, FIELDTYPE *type, ..." 50.Sh DESCRIPTION 51The 52.Fn field_arg 53function returns the field type arguments that are associated with the 54given field. The 55.Fn field_type 56function returns the field type structure associated with the given 57field, this type can be set by calling the 58.Fn set_field_type 59function which associates the given field type with the field, the 60third and subsequent parameters are field dependent arguments. 61.Sh RETURN VALUES 62Functions returning pointers will return NULL if an error is detected. 63The functions that return an int will return one of the following error 64values: 65.Pp 66.Bl -tag -width E_UNKNOWN_COMMAND -compact 67.It Er E_OK 68The function was successful. 69.El 70.Sh SEE ALSO 71.Xr curses 3 , 72.Xr forms 3 73.Sh NOTES 74The header 75.Pa \*[Lt]form.h\*[Gt] 76automatically includes both 77.Pa \*[Lt]curses.h\*[Gt] 78and 79.Pa \*[Lt]eti.h\*[Gt] . 80