man/form_userptr.3x

   1 '\" t
   2 .TH form_userptr 3X ""
   3 .SH NAME
   4 \fBform_userptr\fR - associate application data with a form item
   5 .SH SYNOPSIS
   6 \fB#include <form.h>\fR
   7 .br
   8 int set_form_userptr(FORM *form, const void *userptr);
   9 .br
  10 const void* form_userptr(const FORM *form);
  11 .br
  12 .SH DESCRIPTION
  13 Every form and every form item has a field that can be used to hold
  14 application-specific data (that is, the form-driver code leaves it alone).
  15 These functions get and set the form user pointer field.
  16 .SH RETURN VALUE
  17 The function \fBform_userptr\fR returns \fBNULL\fR on error.
  18 The function \fBset_form_userptr\fR returns one of the following:
  19 .TP 5
  20 \fBE_OK\fR
  21 The routine succeeded.
  22 .TP 5
  23 \fBE_SYSTEM_ERROR\fR
  24 System error occurred (see \fBerrno\fR).
  25 .SH SEE ALSO
  26 \fBcurses\fR(3X), \fBform\fR(3X).
  27 .SH NOTES
  28 The header file \fB<form.h>\fR automatically includes the header file
  29 \fB<curses.h>\fR.
  30 .SH PORTABILITY
  31 These routines emulate the System V forms library.  They were not supported on
  32 Version 7 or BSD versions.
  33
  34 The user pointer should be a void pointer.  We leave it as a char pointer for
  35 SVr4 compatibility.
  36 .SH AUTHORS
  37 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  38 S. Raymond.
  39 .\"#
  40 .\"# The following sets edit modes for GNU EMACS
  41 .\"# Local Variables:
  42 .\"# mode:nroff
  43 .\"# fill-column:79
  44 .\"# End: