IABSD.fr/src/lib/libform/form_field_userptr.3

Branch : - branch - master - tag -

• Show log

  Commit

• Author : jmc
  Date : 2015-11-14 01:35:38
  Hash : 28362de0
  Message : update the NAME section; ok nicm schwarze

• lib/libform/form_field_userptr.3

• '\" t
  .\" $OpenBSD: form_field_userptr.3,v 1.9 2015/11/14 01:35:38 jmc Exp $
  .\"
  .\"***************************************************************************
  .\" Copyright (c) 1998,2006 Free Software Foundation, Inc.                   *
  .\"                                                                          *
  .\" Permission is hereby granted, free of charge, to any person obtaining a  *
  .\" copy of this software and associated documentation files (the            *
  .\" "Software"), to deal in the Software without restriction, including      *
  .\" without limitation the rights to use, copy, modify, merge, publish,      *
  .\" distribute, distribute with modifications, sublicense, and/or sell       *
  .\" copies of the Software, and to permit persons to whom the Software is    *
  .\" furnished to do so, subject to the following conditions:                 *
  .\"                                                                          *
  .\" The above copyright notice and this permission notice shall be included  *
  .\" in all copies or substantial portions of the Software.                   *
  .\"                                                                          *
  .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  .\"                                                                          *
  .\" Except as contained in this notice, the name(s) of the above copyright   *
  .\" holders shall not be used in advertising or otherwise to promote the     *
  .\" sale, use or other dealings in this Software without prior written       *
  .\" authorization.                                                           *
  .\"***************************************************************************
  .\"
  .\" $Id: form_field_userptr.3,v 1.9 2015/11/14 01:35:38 jmc Exp $
  .TH form_field_userptr 3 ""
  .SH NAME
  \fBset_field_userptr\fR, \fBfield_userptr\fR
  - associate application data with a form field
  .SH SYNOPSIS
  \fB#include <form.h>\fR
  .br
  int set_field_userptr(FIELD *field, void*userptr);
  .br
  void *field_userptr(const FIELD *field);
  .br
  .SH DESCRIPTION
  Every form field has a field that can be used to hold application-specific data
  (that is, the form-driver code leaves it alone).  These functions get and set
  that field.
  .SH RETURN VALUE
  The function \fBfield_userptr\fR returns a pointer (which may be \fBNULL\fR).
  It does not set errno.
  .PP
  The function \fBset_field_userptr\fR returns \fBE_OK\fP (success).
  .SH SEE ALSO
  \fBcurses\fR(3), \fBform\fR(3).
  .SH NOTES
  The header file \fB<form.h>\fR automatically includes the header file
  \fB<curses.h>\fR.
  .SH PORTABILITY
  These routines emulate the System V forms library.  They were not supported on
  Version 7 or BSD versions.
  .PP
  The user pointer is a void pointer.
  We chose not to leave it as a char pointer for SVr4 compatibility.
  .SH AUTHORS
  Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  S. Raymond.
  .\"#
  .\"# The following sets edit modes for GNU EMACS
  .\"# Local Variables:
  .\"# mode:nroff
  .\"# fill-column:79
  .\"# End: