ncursesw-morphos/Ada95/html/man/form_field_info.3x.html

73 lines
2.1 KiB
HTML
Raw Normal View History

1997-05-15 12:00:00 +08:00
<HTML>
1999-10-24 12:32:42 +08:00
<BODY>
1997-05-15 12:00:00 +08:00
<PRE>
<STRONG>form_field_info</STRONG> - retrieve field characteristics
</PRE>
<H2>SYNOPSIS</H2><PRE>
1999-10-24 12:32:42 +08:00
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
1997-05-15 12:00:00 +08:00
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 <STRONG>field_info</STRONG> 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 <STRONG>dynamic_field_info</STRONG> 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 <STRONG>O_STATIC</STRONG>).
</PRE>
<H2>RETURN VALUE</H2><PRE>
These routines return one of the following:
<STRONG>E_OK</STRONG> The routine succeeded.
<STRONG>E_SYSTEM_ERROR</STRONG>
System error occurred (see <STRONG>errno</STRONG>).
<STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argu-
ment.
</PRE>
<H2>SEE ALSO</H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG> and 3X pages whose names begin "form_" for
detailed descriptions of the entry points.
</PRE>
<H2>NOTES</H2><PRE>
1999-10-24 12:32:42 +08:00
The header file <STRONG><form.h></STRONG> automatically includes the header
file <STRONG><curses.h></STRONG>.
1997-05-15 12:00:00 +08:00
</PRE>
<H2>PORTABILITY</H2><PRE>
These routines emulate the System V forms library. They
were not supported on Version 7 or BSD versions.
</PRE>
<H2>AUTHORS</H2><PRE>
Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
</PRE>
</BODY>
</HTML>