1.\" $NetBSD: form_field_buffer.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_buffer , 37.Nm field_status , 38.Nm set_field_buffer , 39.Nm set_field_status , 40.Nm set_max_field 41.Nd form library 42.Sh LIBRARY 43.Lb libform 44.Sh SYNOPSIS 45.Fd #include \*[Lt]form.h\*[Gt] 46.Ft char * 47.Fn field_buffer "FIELD *field, int buffer" 48.Ft int 49.Fn field_status "FIELD *field" 50.Ft int 51.Fn set_field_buffer "FIELD *field, int buffer, char *value" 52.Ft int 53.Fn set_field_status "FIELD *field, int status" 54.Sh DESCRIPTION 55The 56.Fn field_buffer 57function returns the contents of the buffer number specified by 58.Fa buffer 59for the given field. If the requested buffer number exceeds the 60number of buffers attached to the field then NULL will be returned. 61The field buffer may be set by calling 62.Fn set_field_buffer 63which will set the given buffer number to the contents of the string 64passed. Calling 65.Fn field_status 66will return the status of the first buffer attached to the field. If 67the field has been modified then the function will return TRUE 68otherwise FALSE is returned, the status of the first buffer may be 69programmatically set by calling 70.Fn set_field_status . 71The maximum growth of a dynamic field can be set by calling 72.Fn set_max_field 73which limits the fields rows if the field is a multiline field or the 74fields columns if the field only has a single row. 75.Sh RETURN VALUES 76Functions returning pointers will return NULL if an error is detected. 77The functions that return an int will return one of the following error 78values: 79.Pp 80.Bl -tag -width E_UNKNOWN_COMMAND -compact 81.It Er E_OK 82The function was successful. 83.It Er E_BAD_ARGUMENT 84A bad parameter was passed to the function. 85.It Er E_SYSTEM_ERROR 86A system error occurred performing the function. 87.El 88.Sh SEE ALSO 89.Xr curses 3 , 90.Xr forms 3 91.Sh NOTES 92The header 93.Pa \*[Lt]form.h\*[Gt] 94automatically includes both 95.Pa \*[Lt]curses.h\*[Gt] 96and 97.Pa \*[Lt]eti.h\*[Gt] . 98