ncurses 6.4 - patch 20230918

[ncurses.git] / man / form_userptr.3x

diff --git a/man/form_userptr.3x b/man/form_userptr.3x
index 4af4e18fd4d0220b67232527a4ea6bca8dd4fabd..e7d9216f4653ad0577aebacd16384c34a8b1e662 100644 (file)
--- a/man/form_userptr.3x
+++ b/man/form_userptr.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright 2018,2020 Thomas E. Dickey                                     *
+.\" Copyright 2018-2022,2023 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 +28,32 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_userptr.3x,v 1.16 2020/02/02 23:34:34 tom Exp $
-.TH form_userptr 3X ""
+.\" $Id: form_userptr.3x,v 1.28 2023/09/16 23:37:03 tom Exp $
+.TH form_userptr 3X 2023-09-16 "ncurses 6.4" "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 <form.h>\fR
-.br
-int set_form_userptr(FORM *form, void *userptr);
-.br
-void* form_userptr(const FORM *form);
+\fB#include <form.h>\fP
+.sp
+\fBint set_form_userptr(FORM *\fIform\fB, void *\fIuserptr\fB);\fR
 .br
+\fBvoid* form_userptr(const FORM *\fIform\fB);\fR
 .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<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