lib/libncurses/man/form_userptr.3

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: form_userptr.3x,v 1.9 1998/11/29 01:08:39 Rick.Ohnemus Exp $
  31 .\" $DragonFly: src/lib/libncurses/man/form_userptr.3,v 1.1 2005/03/12 19:13:54 eirikn Exp $
  32 .TH form_userptr 3X ""
  33 .SH NAME
  34 \fBform_userptr\fR - associate application data with a form item
  35 .SH SYNOPSIS
  36 \fB#include <form.h>\fR
  37 .br
  38 int set_form_userptr(FORM *form, void *userptr);
  39 .br
  40 void* form_userptr(const FORM *form);
  41 .br
  42 .SH DESCRIPTION
  43 Every form and every form item has a field that can be used to hold
  44 application-specific data (that is, the form-driver code leaves it alone).
  45 These functions get and set the form user pointer field.
  46 .SH RETURN VALUE
  47 The function \fBform_userptr\fR returns \fBNULL\fR on error.
  48 The function \fBset_form_userptr\fR returns one of the following:
  49 .TP 5
  50 \fBE_OK\fR
  51 The routine succeeded.
  52 .TP 5
  53 \fBE_SYSTEM_ERROR\fR
  54 System error occurred (see \fBerrno\fR).
  55 .SH SEE ALSO
  56 \fBcurses\fR(3X), \fBform\fR(3X).
  57 .SH NOTES
  58 The header file \fB<form.h>\fR automatically includes the header file
  59 \fB<curses.h>\fR.
  60 .SH PORTABILITY
  61 These routines emulate the System V forms library.  They were not supported on
  62 Version 7 or BSD versions.
  63
  64 The user pointer should be a void pointer.  We leave it as a char pointer for
  65 SVr4 compatibility.
  66 .SH AUTHORS
  67 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  68 S. Raymond.
  69 .\"#
  70 .\"# The following sets edit modes for GNU EMACS
  71 .\"# Local Variables:
  72 .\"# mode:nroff
  73 .\"# fill-column:79
  74 .\"# End: