2004-11-24 15:26:23 +03:00
|
|
|
.\" $NetBSD: form_field_userptr.3,v 1.8 2004/11/24 12:26:23 wiz Exp $
|
2001-07-08 16:10:28 +04:00
|
|
|
.\"
|
|
|
|
|
.\" 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.
|
|
|
|
|
.\"
|
2002-02-20 14:30:57 +03:00
|
|
|
.Dd January 1, 2001
|
2001-07-08 16:10:28 +04:00
|
|
|
.Dt FORMS 3
|
2002-01-15 05:47:02 +03:00
|
|
|
.Os
|
2001-07-08 16:10:28 +04:00
|
|
|
.Sh NAME
|
|
|
|
|
.Nm field_userptr ,
|
|
|
|
|
.Nm set_field_userptr
|
|
|
|
|
.Nd form library
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libform
|
|
|
|
|
.Sh SYNOPSIS
|
2003-04-16 17:34:34 +04:00
|
|
|
.In form.h
|
2001-07-08 16:10:28 +04:00
|
|
|
.Ft void *
|
|
|
|
|
.Fn field_userptr "FIELD *field"
|
|
|
|
|
.Ft int
|
2002-08-06 16:44:34 +04:00
|
|
|
.Fn set_field_userptr "FIELD *field" "void *ptr"
|
2001-07-08 16:10:28 +04:00
|
|
|
.Sh DESCRIPTION
|
2002-01-15 05:47:02 +03:00
|
|
|
The
|
2001-07-08 16:10:28 +04:00
|
|
|
.Fn field_userptr
|
|
|
|
|
function returns the pointer to the user defined data for the field,
|
|
|
|
|
this pointer may be set by calling the
|
|
|
|
|
.Fn set_field_userptr
|
|
|
|
|
function.
|
|
|
|
|
.Sh RETURN VALUES
|
2004-11-24 15:26:23 +03:00
|
|
|
Functions returning pointers will return
|
|
|
|
|
.Dv NULL
|
|
|
|
|
if an error is detected.
|
2001-07-08 16:10:28 +04:00
|
|
|
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.
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr curses 3 ,
|
|
|
|
|
.Xr forms 3
|
|
|
|
|
.Sh NOTES
|
|
|
|
|
The header
|
2004-11-24 15:12:19 +03:00
|
|
|
.Aq Pa form.h
|
2001-07-08 16:10:28 +04:00
|
|
|
automatically includes both
|
2004-11-24 15:12:19 +03:00
|
|
|
.Aq Pa curses.h
|
2001-07-08 16:10:28 +04:00
|
|
|
and
|
2004-11-24 15:12:19 +03:00
|
|
|
.Aq Pa eti.h .
|
