1.\" $NetBSD: form_field_userptr.3,v 1.2 2002/01/15 02:50:17 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, 2001 33.Dt FORMS 3 34.Os 35.Sh NAME 36.Nm field_userptr , 37.Nm set_field_userptr 38.Nd form library 39.Sh LIBRARY 40.Lb libform 41.Sh SYNOPSIS 42.Fd #include <form.h> 43.Ft void * 44.Fn field_userptr "FIELD *field" 45.Ft int 46.Fn set_field_userptr "FIELD *field, void *ptr" 47.Sh DESCRIPTION 48The 49.Fn field_userptr 50function returns the pointer to the user defined data for the field, 51this pointer may be set by calling the 52.Fn set_field_userptr 53function. 54.Sh RETURN VALUES 55Functions returning pointers will return NULL if an error is detected. 56The functions that return an int will return one of the following error 57values: 58.Pp 59.Bl -tag -width E_UNKNOWN_COMMAND -compact 60.It Er E_OK 61The function was successful. 62.El 63.Sh SEE ALSO 64.Xr curses 3 , 65.Xr forms 3 66.Sh NOTES 67The header 68.Pa <form.h> 69automatically includes both 70.Pa <curses.h> 71and 72.Pa <eti.h> . 73