X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_userptr.3x;h=5d3ab1444c357d90717b288d94292b3c2add5c88;hp=a4b8a46bf1a616abe34a1a3f88f84141406b4b93;hb=5925150381bb42a4d8c7116d62c348a7b84309f3;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e diff --git a/man/form_field_userptr.3x b/man/form_field_userptr.3x index a4b8a46b..5d3ab144 100644 --- a/man/form_field_userptr.3x +++ b/man/form_field_userptr.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 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 * @@ -27,24 +28,25 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_userptr.3x,v 1.9 2010/07/31 16:09:36 tom Exp $ +.\" $Id: form_field_userptr.3x,v 1.16 2020/10/24 09:06:33 tom Exp $ .TH form_field_userptr 3X "" .SH NAME -\fBform_field_userptr\fR \- associate application data with a form field +\fBset_field_userptr\fR, +\fBfield_userptr\fR \- associate application data with a form field .SH SYNOPSIS \fB#include \fR +.sp +\fBint set_field_userptr(FIELD *\fP\fIfield\fP\fB, void *\fP\fIuserptr\fP\fB);\fP .br -int set_field_userptr(FIELD *field, void*userptr); -.br -void *field_userptr(const FIELD *field); -.br +\fBvoid *field_userptr(const FIELD *\fP\fIfield\fP\fB);\fP .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 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. +It does not set \fBerrno\fP. .PP The function \fBset_field_userptr\fR returns \fBE_OK\fP (success). .SH SEE ALSO @@ -53,17 +55,12 @@ The function \fBset_field_userptr\fR returns \fBE_OK\fP (success). The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +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: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.