lib/libform/form_userptr.3

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