summaryrefslogtreecommitdiff
path: root/lib/libform/form_field_buffer.3
diff options
context:
space:
mode:
authorblymn <blymn@NetBSD.org>2001-07-08 12:10:28 +0000
committerblymn <blymn@NetBSD.org>2001-07-08 12:10:28 +0000
commite1a3174b3e59997eb4c8c75f0cd41bbd1ba59c5c (patch)
tree1e3104320cb7087609d9b47bf3c85b4f12c5a9c2 /lib/libform/form_field_buffer.3
parentb0b7628145e18d4421eaa259925eae5b408cfd6e (diff)
Add man pages for libform.
Diffstat (limited to 'lib/libform/form_field_buffer.3')
-rw-r--r--lib/libform/form_field_buffer.397
1 files changed, 97 insertions, 0 deletions
diff --git a/lib/libform/form_field_buffer.3 b/lib/libform/form_field_buffer.3
new file mode 100644
index 00000000000..2743580ee47
--- /dev/null
+++ b/lib/libform/form_field_buffer.3
@@ -0,0 +1,97 @@
+.\" $NetBSD: form_field_buffer.3,v 1.1 2001/07/08 12:10:28 blymn Exp $
+.\"
+.\" Copyright (c) 2001
+.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
+.\"
+.\" This code is donated to The NetBSD Foundation by the author.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. The name of the Author may not be used to endorse or promote
+.\" products derived from this software without specific prior written
+.\" permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd January, 2001
+.Dt FORMS 3
+.Os
+.Sh NAME
+.Nm field_buffer ,
+.Nm field_status ,
+.Nm set_field_buffer ,
+.Nm set_field_status ,
+.Nm set_max_field
+.Nd form library
+.Sh LIBRARY
+.Lb libform
+.Sh SYNOPSIS
+.Fd #include <form.h>
+.Ft char *
+.Fn field_buffer "FIELD *field, int buffer"
+.Ft int
+.Fn field_status "FIELD *field"
+.Ft int
+.Fn set_field_buffer "FIELD *field, int buffer, char *value"
+.Ft int
+.Fn set_field_status "FIELD *field, int status"
+.Sh DESCRIPTION
+The
+.Fn field_buffer
+function returns the contents of the buffer number specified by
+.Fa buffer
+for the given field. If the requested buffer number exceeds the
+number of buffers attached to the field then NULL will be returned.
+The field buffer may be set by calling
+.Fn set_field_buffer
+which will set the given buffer number to the contents of the string
+passed. Calling
+.Fn field_status
+will return the status of the first buffer attached to the field. If
+the field has been modified then the function will return TRUE
+otherwise FALSE is returned, the status of the first buffer may be
+programmatically set by calling
+.Fn set_field_status .
+The maximum growth of a dynamic field can be set by calling
+.Fn set_max_field
+which limits the fields rows if the field is a multiline field or the
+fields columns if the field only has a single row.
+.Sh RETURN VALUES
+Functions returning pointers will return NULL if an error is detected.
+The functions that return an int will return one of the following error
+values:
+.Pp
+.Bl -tag -width E_UNKNOWN_COMMAND -compact
+.It Er E_OK
+The function was successful.
+.It Er E_BAD_ARGUMENT
+A bad parameter was passed to the function.
+.It Er E_SYSTEM_ERROR
+A system error occurred performing the function.
+.El
+.Sh SEE ALSO
+.Xr curses 3 ,
+.Xr forms 3
+.Sh NOTES
+The header
+.Pa <form.h>
+automatically includes both
+.Pa <curses.h>
+and
+.Pa <eti.h> .