1.\" $NetBSD: form_field_buffer.3,v 1.6 2002/08/09 14:15:13 blymn 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_printf , 40.Nm set_field_status , 41.Nm set_max_field 42.Nd form library 43.Sh LIBRARY 44.Lb libform 45.Sh SYNOPSIS 46.Fd #include \*[Lt]form.h\*[Gt] 47.Ft char * 48.Fn field_buffer "FIELD *field" "int buffer" 49.Ft int 50.Fn field_status "FIELD *field" 51.Ft int 52.Fn set_field_buffer "FIELD *field" "int buffer" "char *value" 53.Ft int 54.Fn set_field_printf "FIELD *field" "int buffer" "char *fmt" "..." 55.Ft int 56.Fn set_field_status "FIELD *field" "int status" 57.Sh DESCRIPTION 58The 59.Fn field_buffer 60function returns the contents of the buffer number specified by 61.Fa buffer 62for the given field. If the requested buffer number exceeds the 63number of buffers attached to the field then NULL will be returned. 64The field buffer may be set by calling 65.Fn set_field_buffer 66which will set the given buffer number to the contents of the string 67passed. A buffer may also be set by calling 68.Fn set_field_printf 69which sets the buffer using the format arg 70.Fa fmt 71after being expanded using the subsequent arguments in the same manner 72as 73.Xr sprintf 3 74does. Calling 75.Fn field_status 76will return the status of the first buffer attached to the field. If 77the field has been modified then the function will return TRUE 78otherwise FALSE is returned, the status of the first buffer may be 79programmatically set by calling 80.Fn set_field_status . 81The maximum growth of a dynamic field can be set by calling 82.Fn set_max_field 83which limits the fields rows if the field is a multiline field or the 84fields columns if the field only has a single row. 85.Sh RETURN VALUES 86Functions returning pointers will return NULL if an error is detected. 87The functions that return an int will return one of the following error 88values: 89.Pp 90.Bl -tag -width E_UNKNOWN_COMMAND -compact 91.It Er E_OK 92The function was successful. 93.It Er E_BAD_ARGUMENT 94A bad parameter was passed to the function. 95.It Er E_SYSTEM_ERROR 96A system error occurred performing the function. 97.El 98.Sh SEE ALSO 99.Xr curses 3 , 100.Xr forms 3 101.Sh NOTES 102The header 103.Pa \*[Lt]form.h\*[Gt] 104automatically includes both 105.Pa \*[Lt]curses.h\*[Gt] 106and 107.Pa \*[Lt]eti.h\*[Gt] . 108The function 109.Fn set_field_printf 110is a 111.Nx 112extension and must not be used in portable code. 113