1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 Thomas E. Dickey * 4 * Copyright 1998-2010,2015 Free Software Foundation, Inc. * 5 * * 6 * Permission is hereby granted, free of charge, to any person obtaining a * 7 * copy of this software and associated documentation files (the * 8 * "Software"), to deal in the Software without restriction, including * 9 * without limitation the rights to use, copy, modify, merge, publish, * 10 * distribute, distribute with modifications, sublicense, and/or sell * 11 * copies of the Software, and to permit persons to whom the Software is * 12 * furnished to do so, subject to the following conditions: * 13 * * 14 * The above copyright notice and this permission notice shall be included * 15 * in all copies or substantial portions of the Software. * 16 * * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 24 * * 25 * Except as contained in this notice, the name(s) of the above copyright * 26 * holders shall not be used in advertising or otherwise to promote the * 27 * sale, use or other dealings in this Software without prior written * 28 * authorization. * 29 **************************************************************************** 30 * @Id: form_userptr.3x,v 1.36 2024/03/16 15:35:01 tom Exp @ 31--> 32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> 33<HTML> 34<HEAD> 35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> 36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> 37<TITLE>form_userptr 3x 2024-03-16 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">form_userptr 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG> Library calls <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>set_form_userptr</STRONG>, <STRONG>form_userptr</STRONG> - associate application data with a form 51 item 52 53 54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG> 56 57 <STRONG>int</STRONG> <STRONG>set_form_userptr(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>userptr</EM><STRONG>);</STRONG> 58 <STRONG>void*</STRONG> <STRONG>form_userptr(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG> 59 60 61</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 62 Every form and every form item has a field that can be used to hold 63 application-specific data (that is, the form-driver code leaves it 64 alone). These functions get and set the form user pointer field. 65 66 67</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 68 The function <STRONG>form_userptr</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It 69 does not set <STRONG>errno</STRONG>. 70 71 The function <STRONG>set_form_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success). 72 73 74</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 75 These routines emulate the System V forms library. They were not 76 supported on Version 7 or BSD versions. 77 78 The user pointer is a void pointer. We chose not to leave it as a char 79 pointer for SVr4 compatibility. 80 81 82</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 83 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 84 Raymond. 85 86 87</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 88 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG> 89 90 91 92ncurses 6.5 2024-03-16 <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG> 93</PRE> 94<div class="nav"> 95<ul> 96<li><a href="#h2-NAME">NAME</a></li> 97<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 98<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 99<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 100<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 101<li><a href="#h2-AUTHORS">AUTHORS</a></li> 102<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 103</ul> 104</div> 105</BODY> 106</HTML> 107