xref: /freebsd/contrib/ncurses/man/form_userptr.3x (revision 4f29da19bd44f0e99f021510460a81bf754c21d2)
t
***************************************************************************
Copyright (c) 1998 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_userptr.3x,v 1.9 1998/11/29 01:08:39 Rick.Ohnemus Exp $
form_userptr 3X ""
NAME
form_userptr - associate application data with a form item
SYNOPSIS
#include <form.h>

int set_form_userptr(FORM *form, void *userptr);

void* form_userptr(const FORM *form);

DESCRIPTION
Every form and every form item 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 the form user pointer field.
RETURN VALUE
The function form_userptr returns NULL on error. The function set_form_userptr returns one of the following:

5 E_OK The routine succeeded.

5 E_SYSTEM_ERROR System error occurred (see errno).

SEE ALSO
curses(3X), form(3X).
NOTES
The header file <form.h> automatically includes the header file <curses.h>.
PORTABILITY
These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. The user pointer should be a void pointer. We leave it as a char pointer for SVr4 compatibility.
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: