diff options
Diffstat (limited to 'lib/libform/form_field_userptr.3')
| -rw-r--r-- | lib/libform/form_field_userptr.3 | 50 |
1 files changed, 23 insertions, 27 deletions
diff --git a/lib/libform/form_field_userptr.3 b/lib/libform/form_field_userptr.3 index 6cbb483d29b..83e54b58bc9 100644 --- a/lib/libform/form_field_userptr.3 +++ b/lib/libform/form_field_userptr.3 @@ -1,8 +1,9 @@ '\" t -.\" $OpenBSD: form_field_userptr.3,v 1.9 2015/11/14 01:35:38 jmc Exp $ +.\" $OpenBSD: form_field_userptr.3,v 1.10 2023/10/17 09:52:10 nicm Exp $ .\" .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 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 * @@ -29,44 +30,39 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_userptr.3,v 1.9 2015/11/14 01:35:38 jmc Exp $ -.TH form_field_userptr 3 "" +.\" $Id: form_field_userptr.3,v 1.10 2023/10/17 09:52:10 nicm Exp $ +.TH form_field_userptr 3 2022-02-12 "ncurses 6.4" "Library calls" .SH NAME -\fBset_field_userptr\fR, \fBfield_userptr\fR -- associate application data with a form field +\fBset_field_userptr\fP, +\fBfield_userptr\fP \- 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); +\fB#include <form.h>\fP +.sp +\fBint set_field_userptr(FIELD *\fIfield\fB, void *\fIuserptr\fB);\fR .br +\fBvoid *field_userptr(const FIELD *\fIfield\fB);\fR .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. +The function \fBfield_userptr\fP returns a pointer (which may be \fBNULL\fP). +It does not set \fBerrno\fP. .PP -The function \fBset_field_userptr\fR returns \fBE_OK\fP (success). +The function \fBset_field_userptr\fP returns \fBE_OK\fP (success). .SH SEE ALSO -\fBcurses\fR(3), \fBform\fR(3). +\fBcurses\fP(3), \fBform\fP(3). .SH NOTES -The header file \fB<form.h>\fR automatically includes the header file -\fB<curses.h>\fR. +The header file \fB<form.h>\fP automatically includes the header file +\fB<curses.h>\fP. .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. |