lib/libform/form_userptr.3

   1 .\"     $NetBSD: form_userptr.3,v 1.7 2004/11/24 12:12:20 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 form_userptr ,
  37 .Nm set_form_userptr
  38 .Nd form library
  39 .Sh LIBRARY
  40 .Lb libform
  41 .Sh SYNOPSIS
  42 .In form.h
  43 .Ft void *
  44 .Fn form_userptr "FORM *form"
  45 .Ft int
  46 .Fn set_form_userptr "FORM *form" "void *ptr"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn form_userptr
  50 function returns the pointer to the user defined data associated with
  51 the form, this pointer may be set using the
  52 .Fn set_form_userptr
  53 call.
  54 .Sh RETURN VALUES
  55 Functions returning pointers will return
  56 .Dv NULL
  57 if an error is detected.
  58 The functions that return an int will return one of the following error
  59 values:
  60 .Pp
  61 .Bl -tag -width E_UNKNOWN_COMMAND -compact
  62 .It Er E_OK
  63 The function was successful.
  64 .El
  65 .Sh SEE ALSO
  66 .Xr curses 3 ,
  67 .Xr forms 3
  68 .Sh NOTES
  69 The header
  70 .Aq Pa form.h
  71 automatically includes both
  72 .Aq Pa curses.h
  73 and
  74 .Aq Pa eti.h .