ncurses 6.5 - patch 20240511

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

diff --git a/man/mitem_userptr.3x b/man/mitem_userptr.3x
index f2639fda96e9297c5658cbe080a3ad5f2f3213fa..f0eab8bd8058194e43c0dcd678b98c7ba1207fb1 100644 (file)
--- a/man/mitem_userptr.3x
+++ b/man/mitem_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  *
 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -28,34 +27,29 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: mitem_userptr.3x,v 1.14 2020/02/02 23:34:34 tom Exp $
-.TH mitem_userptr 3X ""
+.\" $Id: mitem_userptr.3x,v 1.34 2024/03/16 15:35:01 tom Exp $
+.TH mitem_userptr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .SH NAME
 \fBset_item_userptr\fP,
 .SH NAME
 \fBset_item_userptr\fP,

-\fBitem_userptr\fR \- associate application data with a menu item
+\fBitem_userptr\fP \-
+associate application data with a menu item

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <menu.h>\fR
-.br
-int set_item_userptr(ITEM *item, void *userptr);
-.br
-void *item_userptr(const ITEM *item);
-.br
+.nf
+\fB#include <menu.h>
+.PP
+\fBint set_item_userptr(ITEM *\fIitem\fP, void *\fIuserptr\fP);
+\fBvoid *item_userptr(const ITEM *\fIitem\fP);
+.fi

 .SH DESCRIPTION
 Every menu item has a field that can be used to hold application-specific data
 (that is, the menu-driver code leaves it alone).
 These functions get and set
 that field.
 .SH RETURN VALUE
 .SH DESCRIPTION
 Every menu item has a field that can be used to hold application-specific data
 (that is, the menu-driver code leaves it alone).
 These functions get and set
 that field.
 .SH RETURN VALUE

-The function \fBitem_userptr\fR returns a pointer (possibly \fBNULL\fR).
-It does not set errno.
+The function \fBitem_userptr\fP returns a pointer (possibly \fBNULL\fP).
+It does not set \fBerrno\fP.

 .PP
 The \fBset_item_userptr\fP always returns \fBE_OK\fP (success).
 .PP
 The \fBset_item_userptr\fP always returns \fBE_OK\fP (success).

-.
-.SH SEE ALSO
-\fBcurses\fR(3X), \fBmenu\fR(3X).
-.SH NOTES
-The header file \fB<menu.h>\fR automatically includes the header file
-\fB<curses.h>\fR.

 .SH PORTABILITY
 These routines emulate the System V menu library.
 They were not supported on
 .SH PORTABILITY
 These routines emulate the System V menu library.
 They were not supported on


@@ -66,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 AUTHORS
 Juergen Pfeifer.
 Manual pages and adaptation for new curses by Eric S. Raymond.

+.SH SEE ALSO
+\fB\%curses\fP(3X),
+\fB\%menu\fP(3X)