summaryrefslogtreecommitdiffstats
path: root/ncurses-5.2/doc/html/man/form_field_info.3x.html
diff options
context:
space:
mode:
Diffstat (limited to 'ncurses-5.2/doc/html/man/form_field_info.3x.html')
-rw-r--r--ncurses-5.2/doc/html/man/form_field_info.3x.html82
1 files changed, 82 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/form_field_info.3x.html b/ncurses-5.2/doc/html/man/form_field_info.3x.html
new file mode 100644
index 0000000..40ef3a2
--- /dev/null
+++ b/ncurses-5.2/doc/html/man/form_field_info.3x.html
@@ -0,0 +1,82 @@
+<HTML>
+<BODY>
+<PRE>
+<!-- Manpage converted by man2html 3.0.1 -->
+
+</PRE>
+<H2>NAME</H2><PRE>
+ <B>form_field_info</B> - retrieve field characteristics
+
+
+</PRE>
+<H2>SYNOPSIS</H2><PRE>
+ <B>#include</B> <B>&lt;form.h&gt;</B>
+ int field_info(const FIELD *field, int *rows, int *cols,
+ int *frow, int *fcol, int *nrow, int *nbuf);
+ int dynamic_field_info(const FIELD *field, int *rows, int
+ *cols, *max);
+
+
+</PRE>
+<H2>DESCRIPTION</H2><PRE>
+ The function <B>field_info</B> returns the sizes and other
+ attributes passed in to the field at its creation time.
+ The attributes are: height, width, row of upper-left cor-
+ ner, column of upper-left corner, number off-screen rows,
+ and number of working buffers.
+
+ The function <B>dynamic_field_info</B> returns the actual size of
+ the field, and its maximum possible size. If the field
+ has no size limit, the location addressed by the third
+ argument will be set to 0. (A field can be made dynamic
+ by turning off the <B>O_STATIC</B>).
+
+
+</PRE>
+<H2>RETURN VALUE</H2><PRE>
+ These routines return one of the following:
+
+ <B>E_OK</B> The routine succeeded.
+
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno</B>).
+
+ <B>E_BAD_ARGUMENT</B>
+ Routine detected an incorrect or out-of-range argu-
+ ment.
+
+
+</PRE>
+<H2>SEE ALSO</H2><PRE>
+ <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "form_" for
+ detailed descriptions of the entry points.
+
+
+</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.
+
+ A null (zero pointer) is accepted for any of the return
+ values, to ignore that value. Not all implementations
+ allow this, e.g., Solaris 2.7 does not.
+
+
+</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>