mirror/ncursesw-morphos
2
0
Fork 0
mirror of https://github.com/Aigor44/ncursesw-morphos.git synced 2024-12-15 07:30:12 +08:00
Code Issues Packages Projects Releases Wiki Activity
6830dca51a
ncursesw-morphos/man/mitem_userptr.3x

69 lines
3.3 KiB
Plaintext
Raw Normal View History

ncurses 4.1
1997-05-15 12:00:00 +08:00
'\" t
ncurses 5.0
1999-10-24 12:32:42 +08:00
.\"***************************************************************************
ncurses 6.2 - patch 20200212 + update release notes + minor build-fixes, mostly to test-package scripts + modify check for sizeof(wchar_t) to ensure it gives useful result when cross-compiling. + drop assumption in configure script that Cygwin's linker is broken. + define NCURSES_BROKEN_LINKER if the broken-linker feature is used, to simplify configure-checks for ncurses-examples. + reassert copyright on ncurses, per discussion in ncurses FAQ: https://invisible-island.net/ncurses/ncurses.faq.html#relicensed + modify comparison in make_hash.c to correct a special case in collision handling for Caps-hpux11 + add testing utility report_hashing to check hash-tables used for terminfo and termcap names. + fix a missing prototype for _nc_free_and_exit(). + update a few comments about tack 1.07 + use an awk script to split too-long pathnames used in Ada95 sample programs for explain.txt
2020-02-12 17:50:22 +08:00
.\" Copyright 2018,2020 Thomas E. Dickey *
.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
ncurses 5.0
1999-10-24 12:32:42 +08:00
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" copy of this software and associated documentation files (the *
.\" "Software"), to deal in the Software without restriction, including *
.\" without limitation the rights to use, copy, modify, merge, publish, *
.\" distribute, distribute with modifications, sublicense, and/or sell *
.\" copies of the Software, and to permit persons to whom the Software is *
.\" furnished to do so, subject to the following conditions: *
.\" *
.\" The above copyright notice and this permission notice shall be included *
.\" in all copies or substantial portions of the Software. *
.\" *
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
.\" *
.\" Except as contained in this notice, the name(s) of the above copyright *
.\" holders shall not be used in advertising or otherwise to promote the *
.\" sale, use or other dealings in this Software without prior written *
.\" authorization. *
.\"***************************************************************************
.\"
ncurses 6.2 - patch 20201017 + improve manpage typography. + improve discussion in curs_addch.3x of the use of unctrl to display nonprintable characters. + add a note in terminfo.5 explaining that no-parameter strings such as sgr0 or cnorm should not be used with tparm.
2020-10-18 09:25:54 +08:00
.\" $Id: mitem_userptr.3x,v 1.17 2020/10/18 00:36:16 tom Exp $
ncurses 4.1
1997-05-15 12:00:00 +08:00
.TH mitem_userptr 3X ""
.SH NAME
ncurses 6.0 - patch 20151205 + update form_cursor.3x, form_post.3x, menu_attributes.3x to list function names in NAME section (patch by Jason McIntyre). + minor fixes to manpage NAME/SYNOPSIS sections to consistently use rule that either all functions which are prototyped in SYNOPSIS are listed in the NAME section, or the manual-page name is the sole item listed in the NAME section. The latter is used to reduce clutter, e.g., for the top-level library manual pages as well as for certain feature-pages such as SP-funcs and threading (prompted by patches by Jason McIntyre). + add option to preserve leading whitespace in form fields (patch by Leon Winter).
2015-12-06 09:07:45 +08:00
\fBset_item_userptr\fP,
\fBitem_userptr\fR \- associate application data with a menu item
ncurses 4.1
1997-05-15 12:00:00 +08:00
.SH SYNOPSIS
\fB#include <menu.h>\fR
ncurses 6.2 - patch 20201017 + improve manpage typography. + improve discussion in curs_addch.3x of the use of unctrl to display nonprintable characters. + add a note in terminfo.5 explaining that no-parameter strings such as sgr0 or cnorm should not be used with tparm.
2020-10-18 09:25:54 +08:00
.sp
\fBint set_item_userptr(ITEM *\fP\fIitem\fP\fB, void *\fP\fIuserptr\fP\fB);\fP
ncurses 4.1
1997-05-15 12:00:00 +08:00
.br
ncurses 6.2 - patch 20201017 + improve manpage typography. + improve discussion in curs_addch.3x of the use of unctrl to display nonprintable characters. + add a note in terminfo.5 explaining that no-parameter strings such as sgr0 or cnorm should not be used with tparm.
2020-10-18 09:25:54 +08:00
\fBvoid *item_userptr(const ITEM *\fP\fIitem\fP\fB);\fP
ncurses 4.1
1997-05-15 12:00:00 +08:00
.br
.SH DESCRIPTION
Every menu item has a field that can be used to hold application-specific data
ncurses 6.1 - patch 20180728 + improve documentation regarding feature-test macros in curses.h + improve documentation regarding the virtual and physical screens. + formatting fixes for manpages, regenerate man-html documentation.
2018-07-29 09:43:55 +08:00
(that is, the menu-driver code leaves it alone).
These functions get and set
ncurses 4.1
1997-05-15 12:00:00 +08:00
that field.
.SH RETURN VALUE
ncurses 5.6
2006-12-18 12:32:42 +08:00
The function \fBitem_userptr\fR returns a pointer (possibly \fBNULL\fR).
ncurses 6.2 - patch 20200328 + correct length of buffer copied in dup_field(). + remove "$(srcdir)/" from path of library.gpr, needed for out-of-tree builds of Ada95 (patch by Adam Van Ymeren).
2020-03-29 09:03:54 +08:00
It does not set \fBerrno\fP.
ncurses 5.6
2006-12-18 12:32:42 +08:00
.PP
The \fBset_item_userptr\fP always returns \fBE_OK\fP (success).
.
ncurses 4.1
1997-05-15 12:00:00 +08:00
.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
ncurses 6.1 - patch 20180728 + improve documentation regarding feature-test macros in curses.h + improve documentation regarding the virtual and physical screens. + formatting fixes for manpages, regenerate man-html documentation.
2018-07-29 09:43:55 +08:00
These routines emulate the System V menu library.
They were not supported on
ncurses 4.1
1997-05-15 12:00:00 +08:00
Version 7 or BSD versions.
ncurses 5.6
2006-12-18 12:32:42 +08:00
.PP
The user pointer is a void pointer.
We chose not to leave it as a char pointer for SVr4 compatibility.
ncurses 4.1
1997-05-15 12:00:00 +08:00
.SH AUTHORS
ncurses 6.1 - patch 20180728 + improve documentation regarding feature-test macros in curses.h + improve documentation regarding the virtual and physical screens. + formatting fixes for manpages, regenerate man-html documentation.
2018-07-29 09:43:55 +08:00
Juergen Pfeifer.
Manual pages and adaptation for new curses by Eric S. Raymond.
Reference in New Issue Copy Permalink