X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_userptr.3x;h=11c990c0030b4403819cc95c6bd02e2ae448cb5d;hb=HEAD;hp=266b13efd286163b71bf5b88cecd8e466d2bdc44;hpb=f44733b760290aa8f51c6c9e1e463254833bffcd;p=ncurses.git diff --git a/man/form_userptr.3x b/man/form_userptr.3x index 266b13ef..11c990c0 100644 --- a/man/form_userptr.3x +++ b/man/form_userptr.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,32 +27,28 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_userptr.3x,v 1.17 2020/03/28 19:06:28 tom Exp $ -.TH form_userptr 3X "" +.\" $Id: form_userptr.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH form_userptr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME \fBset_form_userptr\fP, -\fBform_userptr\fR \- associate application data with a form item +\fBform_userptr\fP \- +associate application data with a form item .SH SYNOPSIS -\fB#include \fR -.br -int set_form_userptr(FORM *form, void *userptr); -.br -void* form_userptr(const FORM *form); -.br +.nf +\fB#include +.PP +\fBint set_form_userptr(FORM *\fIform\fP, void *\fIuserptr\fP); +\fBvoid* form_userptr(const FORM *\fIform\fP); +.fi .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). +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). -.SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). -.SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The function \fBset_form_userptr\fP returns \fBE_OK\fP (success). .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -64,3 +59,6 @@ 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. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X)