X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fform_field_userptr.3x;h=6eea09201e76db53d95ee4cc67149818cf2d6892;hb=HEAD;hp=862943a55b34b948d021e055d94616b30502b78b;hpb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045;p=ncurses.git diff --git a/man/form_field_userptr.3x b/man/form_field_userptr.3x index 862943a5..6eea0920 100644 --- a/man/form_field_userptr.3x +++ b/man/form_field_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,29 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_userptr.3x,v 1.15 2020/10/17 23:07:03 tom Exp $ -.TH form_field_userptr 3X "" +.\" $Id: form_field_userptr.3x,v 1.30 2024/03/16 15:35:01 tom Exp $ +.TH form_field_userptr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "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 \fR -.sp -int set_field_userptr(FIELD *field, void*userptr); -.br -void *field_userptr(const FIELD *field); +.nf +\fB#include +.PP +\fBint set_field_userptr(FIELD *\fIfield\fP, void *\fIuserptr\fP); +\fBvoid *field_userptr(const FIELD *\fIfield\fP); +.fi .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 field. .SH RETURN VALUE -The function \fBfield_userptr\fR returns a pointer (which may be \fBNULL\fR). +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). -.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_field_userptr\fP returns \fBE_OK\fP (success). .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -64,3 +60,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)