-<!--
+<!--
* t
****************************************************************************
- * Copyright (c) 1998-2015,2018 Free Software Foundation, Inc. *
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_field_info.3x,v 1.14 2018/07/28 21:34:06 tom Exp @
+ * @Id: form_field_info.3x,v 1.18 2020/10/17 23:35:05 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>form_field_info 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<TITLE>form_field_info 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1 class="no-header">form_field_info 3x</H1>
+<H1 class="no-header">form_field_info 3X</H1>
<PRE>
-<STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG> <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
+<B><A HREF="form_field_info.3X.html">form_field_info(3X)</A></B> <B><A HREF="form_field_info.3X.html">form_field_info(3X)</A></B>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>dynamic_field_info</STRONG>, <STRONG>field_info</STRONG> - retrieve field characteristics
+ <B>dynamic_field_info</B>, <B>field_info</B> - retrieve field characteristics
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
- 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, int
- *max);
+ <B>#include</B> <B><form.h></B>
+
+ <B>int</B> <B>field_info(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>,</B>
+ <B>int</B> <B>*</B><I>rows</I><B>,</B> <B>int</B> <B>*</B><I>cols</I><B>,</B>
+ <B>int</B> <B>*</B><I>frow</I><B>,</B> <B>int</B> <B>*</B><I>fcol</I><B>,</B>
+ <B>int</B> <B>*</B><I>nrow</I><B>,</B> <B>int</B> <B>*</B><I>nbuf</I><B>);</B>
+
+ <B>int</B> <B>dynamic_field_info(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>,</B>
+ <B>int</B> <B>*</B><I>rows</I><B>,</B> <B>int</B> <B>*</B><I>cols</I><B>,</B> <B>int</B> <B>*</B><I>max</I><B>);</B>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></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 corner, column of upper-left corner, number
+ 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 corner, 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
+ 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 <STRONG>O_STATIC</STRONG> option with <STRONG>field_opts_off</STRONG>.
+ be made dynamic by turning off the <B>O_STATIC</B> option with <B>field_opts_off</B>.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
These routines return one of the following:
- <STRONG>E_OK</STRONG> The routine succeeded.
+ <B>E_OK</B> The routine succeeded.
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno(3)</B>).
- <STRONG>E_BAD_ARGUMENT</STRONG>
+ <B>E_BAD_ARGUMENT</B>
Routine detected an incorrect or out-of-range argument.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for detailed
+ <B><A HREF="curses.3X.html">curses(3X)</A></B> and related pages whose names begin "form_" for detailed
descriptions of the entry points.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- The header file <STRONG><form.h></STRONG> automatically includes the header file
- <STRONG><curses.h></STRONG>.
+ The header file <B><form.h></B> automatically includes the header file
+ <B><curses.h></B>.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- These routines emulate the System V forms library. They were not sup-
- ported on Version 7 or BSD versions.
+ 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
+ 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.
- <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
+ <B><A HREF="form_field_info.3X.html">form_field_info(3X)</A></B>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff