ncurses-5.2/doc/html/man/form_field_userptr.3x.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
       <B>form_field_userptr</B>  -  associate  application  data with a
       form field


</PRE>
<H2>SYNOPSIS</H2><PRE>
       <B>#include</B> <B>&lt;form.h&gt;</B>
       int set_field_userptr(FIELD *field, void*userptr);
       void *field_userptr(const FIELD *field);


</PRE>
<H2>DESCRIPTION</H2><PRE>
       Every form field 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 that field.


</PRE>
<H2>RETURN VALUE</H2><PRE>
       The  function  <B>field_userptr</B>  returns  <B>NULL</B>  on error. The
       function <B>set_field_userptr</B> returns one of the following:

       <B>E_OK</B> The routine succeeded.

       <B>E_SYSTEM_ERROR</B>
            System error occurred (see <B>errno</B>).


</PRE>
<H2>SEE ALSO</H2><PRE>
       <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.


</PRE>
<H2>NOTES</H2><PRE>
       The header file <B>&lt;form.h&gt;</B> automatically includes the header
       file <B>&lt;curses.h&gt;</B>.


</PRE>
<H2>PORTABILITY</H2><PRE>
       These  routines  emulate the System V forms library.  They
       were not supported on Version 7 or BSD versions.

       The user pointer should be a void pointer.  We leave it as
       a char pointer for SVr4 compatibility.


</PRE>
<H2>AUTHORS</H2><PRE>
       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
       curses by Eric S. Raymond.


</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>