X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_userptr.3x;h=47fcc294362d518c401b90bc176bae3f1e23e69d;hb=4c9f63c460cb7134f142aa65f6866c175ed77605;hp=e9e5422ac167aa322fa639a1d6d04cfe5725da29;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e;p=ncurses.git diff --git a/man/form_userptr.3x b/man/form_userptr.3x index e9e5422a..47fcc294 100644 --- a/man/form_userptr.3x +++ b/man/form_userptr.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 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 * @@ -27,43 +28,39 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_userptr.3x,v 1.12 2010/07/31 16:08:48 tom Exp $ +.\" $Id: form_userptr.3x,v 1.22 2022/02/12 20:03:40 tom Exp $ .TH form_userptr 3X "" .SH NAME -\fBform_userptr\fR \- associate application data with a form item +\fBset_form_userptr\fP, +\fBform_userptr\fP \- associate application data with a form item .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_form_userptr(FORM *\fIform\fB, void *\fIuserptr\fB);\fR .br -int set_form_userptr(FORM *form, void *userptr); -.br -void* form_userptr(const FORM *form); +\fBvoid* form_userptr(const FORM *\fIform\fB);\fR .br .SH 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. .SH RETURN VALUE -The function \fBform_userptr\fR returns a pointer (which may be \fBNULL\fR). -It does not set errno. +The function \fBform_userptr\fP returns a pointer (which may be \fBNULL\fP). +It does not set \fBerrno\fP. .PP -The function \fBset_form_userptr\fR returns \fBE_OK\fP (success). +The function \fBset_form_userptr\fP returns \fBE_OK\fP (success). .SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). +\fBcurses\fP(3X), \fBform\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\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.