ncurses 5.0
[ncurses.git] / Ada95 / html / man / form_field_buffer.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4        <STRONG>form_field_buffer</STRONG> - field buffer control
5
6
7 </PRE>
8 <H2>SYNOPSIS</H2><PRE>
9        <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
10        int  set_field_buffer(FIELD  *field,  int  buf, const char
11        *value);
12        char *field_buffer(const FIELD *field, int buffer);
13        int set_field_status(FIELD *field, bool status);
14        bool field_status(const FIELD *field);
15        int set_max_field(FIELD *field, int max);
16
17
18 </PRE>
19 <H2>DESCRIPTION</H2><PRE>
20        The function <STRONG>set_field_buffer</STRONG> sets the numbered buffer  of
21        the  given  field  to contain a given string.  Buffer 0 is
22        the displayed value of the field; other  numbered  buffers
23        may be allocated by applications through the <STRONG>nbuf</STRONG> argument
24        of (see <STRONG><A HREF="form_field_new.3x.html">form_field_new(3X)</A></STRONG>) but are not manipulated by the
25        forms  library.   The  function  <STRONG>field_buffer</STRONG>  returns the
26        address of the buffer.
27
28        The function <STRONG>set_field_status</STRONG> sets the  associated  status
29        flag  of  <EM>field</EM>; <STRONG>field_status</STRONG> gets the current value.  The
30        status flag is set to a nonzero value whenever  the  field
31        changes.
32
33        The  function  <STRONG>set_max_field</STRONG>  sets  the maximum size for a
34        dynamic field.  An argument of 0  turns  off  any  maximum
35        size threshold for that field.
36
37
38 </PRE>
39 <H2>RETURN VALUE</H2><PRE>
40        The <STRONG>field_buffer</STRONG> function returns NULL on error.
41
42        The <STRONG>field_status</STRONG> function returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
43
44        The remaining routines return one of the following:
45
46        <STRONG>E_OK</STRONG> The routine succeeded.
47
48        <STRONG>E_SYSTEM_ERROR</STRONG>
49             System error occurred (see <STRONG>errno</STRONG>).
50
51        <STRONG>E_BAD_ARGUMENT</STRONG>
52             Routine  detected  an incorrect or out-of-range argu-
53             ment.
54
55
56 </PRE>
57 <H2>SEE ALSO</H2><PRE>
58        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG> and 3X pages  whose  names  begin  "form_"  for
59        detailed descriptions of the entry points.
60
61
62 </PRE>
63 <H2>NOTES</H2><PRE>
64        The header file <STRONG><form.h></STRONG> automatically includes the header
65        file <STRONG><curses.h></STRONG>.
66        These routines emulate the System V forms  library.   They
67        were not supported on Version 7 or BSD versions.
68
69
70 </PRE>
71 <H2>AUTHORS</H2><PRE>
72        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
73        curses by Eric S. Raymond.
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120 </PRE>
121 </BODY>
122 </HTML>