-<!--
+<!--
* t
****************************************************************************
- * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc. *
+ * Copyright 2018,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_new.3x,v 1.19 2015/12/05 23:42:45 tom Exp @
+ * @Id: form_field_new.3x,v 1.24 2020/10/24 09:09:18 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_new 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<TITLE>form_field_new 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_new 3x</H1>
+<H1 class="no-header">form_field_new 3X</H1>
<PRE>
-<STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
+<B><A HREF="form_field_new.3X.html">form_field_new(3X)</A></B> <B><A HREF="form_field_new.3X.html">form_field_new(3X)</A></B>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG>, <STRONG>free_field</STRONG> - create and destroy form
+ <B>new_field</B>, <B>dup_field</B>, <B>link_field</B>, <B>free_field</B> - create and destroy form
fields
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
- FIELD *new_field(int height, int width,
- int toprow, int leftcol,
- int offscreen, int nbuffers);
- FIELD *dup_field(FIELD *field, int toprow, int leftcol);
- FIELD *link_field(FIELD *field, int toprow, int leftcol);
- int free_field(FIELD *field);
+ <B>#include</B> <B><form.h></B>
+
+ <B>FIELD</B> <B>*new_field(int</B> <I>height</I><B>,</B> <B>int</B> <I>width</I><B>,</B>
+ <B>int</B> <I>toprow</I><B>,</B> <B>int</B> <I>leftcol</I><B>,</B>
+ <B>int</B> <I>offscreen</I><B>,</B> <B>int</B> <I>nbuffers</I><B>);</B>
+ <B>FIELD</B> <B>*dup_field(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>int</B> <I>toprow</I><B>,</B> <B>int</B> <I>leftcol</I><B>);</B>
+ <B>FIELD</B> <B>*link_field(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>int</B> <I>toprow</I><B>,</B> <B>int</B> <I>leftcol</I><B>);</B>
+ <B>int</B> <B>free_field(FIELD</B> <B>*</B><I>field</I><B>);</B>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The function <STRONG>new_field</STRONG> allocates a new field and initializes it from
+ The function <B>new_field</B> allocates a new field and initializes it from
the parameters given: height, width, row of upper-left corner, column
of upper-left corner, number off-screen rows, and number of additional
working buffers.
- The function <STRONG>dup_field</STRONG> duplicates a field at a new location. Most
+ The function <B>dup_field</B> duplicates a field at a new location. Most
attributes (including current contents, size, validation type, buffer
count, growth threshold, justification, foreground, background, pad
character, options, and user pointer) are copied. Field status and the
field page bit are not copied.
- The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but the new field shares
+ The function <B>link_field</B> acts like <B>dup_field</B>, but the new field shares
buffers with its parent. Attribute data is separate.
- The function <STRONG>free_field</STRONG> de-allocates storage associated with a field.
+ The function <B>free_field</B> de-allocates storage associated with a field.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG> on error.
- They set errno according to their success:
+ The functions <B>new_field</B>, <B>dup_field</B>, <B>link_field</B> return <B>NULL</B> on error.
+ They set <B>errno</B> according to their success:
- <STRONG>E_OK</STRONG> The routine succeeded.
+ <B>E_OK</B> The routine succeeded.
- <STRONG>E_BAD_ARGUMENT</STRONG>
+ <B>E_BAD_ARGUMENT</B>
Routine detected an incorrect or out-of-range argument.
- <STRONG>E_SYSTEM_ERROR</STRONG>
+ <B>E_SYSTEM_ERROR</B>
System error occurred, e.g., malloc failure.
- The function <STRONG>free_field</STRONG> returns one of the following:
+ The function <B>free_field</B> returns one of the following:
- <STRONG>E_OK</STRONG> The routine succeeded.
+ <B>E_OK</B> The routine succeeded.
- <STRONG>E_BAD_ARGUMENT</STRONG>
+ <B>E_BAD_ARGUMENT</B>
Routine detected an incorrect or out-of-range argument.
- <STRONG>E_CONNECTED</STRONG>
+ <B>E_CONNECTED</B>
field is connected.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="form.3X.html">form(3X)</A></B>.
</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.
- It may be unwise to count on the set of attributes copied by <STRONG>dup_field</STRONG>
+ It may be unwise to count on the set of attributes copied by <B>dup_field</B>
being portable; the System V forms library documents are not very
explicit about what gets copied and what does not.
- <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
+ <B><A HREF="form_field_new.3X.html">form_field_new(3X)</A></B>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff