ncurses 6.2 - patch 20210213
[ncurses.git] / man / form_userptr.3x
index 14179f74152ee0669be1759b0a6727bd841bca90..5651a95f57e1f719f13b0cf3b61473764848f07d 100644 (file)
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
+.\" Copyright 2018,2020 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_userptr.3x,v 1.14 2015/12/05 23:42:45 tom Exp $
+.\" $Id: form_userptr.3x,v 1.19 2020/10/24 09:00:52 tom Exp $
 .TH form_userptr 3X ""
 .SH NAME
 \fBset_form_userptr\fP,
 \fBform_userptr\fR \- associate application data with a form item
 .SH SYNOPSIS
 \fB#include <form.h>\fR
+.sp
+\fBint set_form_userptr(FORM *\fP\fIform\fP\fB, void *\fP\fIuserptr\fP\fB);\fP
 .br
-int set_form_userptr(FORM *form, void *userptr);
-.br
-void* form_userptr(const FORM *form);
+\fBvoid* form_userptr(const FORM *\fP\fIform\fP\fB);\fP
 .br
 .SH DESCRIPTION
 Every form and every form item has a field that can be used to hold
@@ -45,7 +46,7 @@ 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.
+It does not set \fBerrno\fP.
 .PP
 The function \fBset_form_userptr\fR returns \fBE_OK\fP (success).
 .SH SEE ALSO
@@ -54,11 +55,12 @@ The function \fBset_form_userptr\fR returns \fBE_OK\fP (success).
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
 .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.
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.