ncurses 5.0
[ncurses.git] / Ada95 / html / man / form_field_userptr.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4        <STRONG>form_field_userptr</STRONG>  -  associate  application  data with a
5        form field
6
7
8 </PRE>
9 <H2>SYNOPSIS</H2><PRE>
10        <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
11        int set_field_userptr(FIELD *field, void*userptr);
12        void *field_userptr(const FIELD *field);
13
14
15 </PRE>
16 <H2>DESCRIPTION</H2><PRE>
17        Every form field has a field that  can  be  used  to  hold
18        application-specific  data  (that is, the form-driver code
19        leaves it alone).  These functions get and set that field.
20
21
22 </PRE>
23 <H2>RETURN VALUE</H2><PRE>
24        The  function  <STRONG>field_userptr</STRONG>  returns  <STRONG>NULL</STRONG>  on error. The
25        function <STRONG>set_field_userptr</STRONG> returns one of the following:
26
27        <STRONG>E_OK</STRONG> The routine succeeded.
28
29        <STRONG>E_SYSTEM_ERROR</STRONG>
30             System error occurred (see <STRONG>errno</STRONG>).
31
32
33 </PRE>
34 <H2>SEE ALSO</H2><PRE>
35        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
36
37
38 </PRE>
39 <H2>NOTES</H2><PRE>
40        The header file <STRONG><form.h></STRONG> automatically includes the header
41        file <STRONG><curses.h></STRONG>.
42
43
44 </PRE>
45 <H2>PORTABILITY</H2><PRE>
46        These  routines  emulate the System V forms library.  They
47        were not supported on Version 7 or BSD versions.
48
49        The user pointer should be a void pointer.  We leave it as
50        a char pointer for SVr4 compatibility.
51
52
53 </PRE>
54 <H2>AUTHORS</H2><PRE>
55        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
56        curses by Eric S. Raymond.
57
58
59
60
61
62
63
64
65
66
67
68
69
70 </PRE>
71 </BODY>
72 </HTML>