<!--
- * t
****************************************************************************
- * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 2018-2023,2024 Thomas E. Dickey *
* Copyright 1998-2010,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_field_buffer.3x,v 1.27 2020/10/24 09:27:17 tom Exp @
+ * @Id: form_field_buffer.3x,v 1.45 2024/03/16 15:35:01 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_buffer 3X</TITLE>
+<TITLE>form_field_buffer 3x 2024-03-16 ncurses 6.4 Library calls</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_buffer 3X</H1>
+<H1 class="no-header">form_field_buffer 3x 2024-03-16 ncurses 6.4 Library calls</H1>
<PRE>
-<B><A HREF="form_field_buffer.3X.html">form_field_buffer(3X)</A></B> <B><A HREF="form_field_buffer.3X.html">form_field_buffer(3X)</A></B>
+<STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG> Library calls <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <B>form_field_buffer</B> - field buffer control
+ <STRONG>form_field_buffer</STRONG> - field buffer control
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <B>#include</B> <B><form.h></B>
+ <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
- <B>int</B> <B>set_field_buffer(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>int</B> <I>buf</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>value</I><B>);</B>
- <B>char</B> <B>*field_buffer(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>,</B> <B>int</B> <I>buffer</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>set_field_buffer(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>buf</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>value</EM><STRONG>);</STRONG>
+ <STRONG>char</STRONG> <STRONG>*field_buffer(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>buffer</EM><STRONG>);</STRONG>
- <B>int</B> <B>set_field_status(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>bool</B> <I>status</I><B>);</B>
- <B>bool</B> <B>field_status(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>set_field_status(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>status</EM><STRONG>);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>field_status(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
- <B>int</B> <B>set_max_field(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>int</B> <I>max</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>set_max_field(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>max</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The function <B>set_field_buffer</B> sets the numbered buffer of the given
+ The function <STRONG>set_field_buffer</STRONG> sets the numbered buffer of the given
field to contain a given string:
- <B>o</B> Buffer 0 is the displayed value of the field.
+ <STRONG>o</STRONG> Buffer 0 is the displayed value of the field.
- <B>o</B> Other numbered buffers may be allocated by applications through
- the <B>nbuf</B> argument of (see <B><A HREF="form_field_new.3X.html">form_field_new(3X)</A></B>) but are not
+ <STRONG>o</STRONG> Other numbered buffers may be allocated by applications through
+ the <STRONG>nbuf</STRONG> argument of (see <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>) but are not
manipulated by the forms library.
- The function <B>field_buffer</B> returns a pointer to the contents of the
+ The function <STRONG>field_buffer</STRONG> returns a pointer to the contents of the
given numbered buffer:
- <B>o</B> The buffer contents always have the same length, and are padded
+ <STRONG>o</STRONG> The buffer contents always have the same length, and are padded
with trailing spaces as needed to ensure this length is the
same.
- <B>o</B> The buffer may contain leading spaces, depending on how it was
+ <STRONG>o</STRONG> The buffer may contain leading spaces, depending on how it was
set.
- <B>o</B> The buffer contents are set with <B>set_field_buffer</B>, or as a side
+ <STRONG>o</STRONG> The buffer contents are set with <STRONG>set_field_buffer</STRONG>, or as a side
effect of any editing operations on the corresponding field.
- <B>o</B> Editing operations are based on the <I>window</I> which displays the
- field, rather than a <I>string</I>. The window contains only printable
+ <STRONG>o</STRONG> Editing operations are based on the <EM>window</EM> which displays the
+ field, rather than a <EM>string</EM>. The window contains only printable
characters, and is filled with blanks. If you want the raw
data, you must write your own routine that copies the value out
of the buffer and removes the leading and trailing spaces.
- <B>o</B> Because editing operations change the content of the buffer to
+ <STRONG>o</STRONG> Because editing operations change the content of the buffer to
correspond to the window, you should not rely on using buffers
for long-term storage of form data.
- The function <B>set_field_status</B> sets the associated status flag of <I>field</I>;
- <B>field_status</B> gets the current value. The status flag is set to a
+ The function <STRONG>set_field_status</STRONG> sets the associated status flag of <EM>field</EM>;
+ <STRONG>field_status</STRONG> gets the current value. The status flag is set to a
nonzero value whenever the field changes.
- The function <B>set_max_field</B> sets the maximum size for a dynamic field.
+ The function <STRONG>set_max_field</STRONG> sets the maximum size for a dynamic field.
An argument of 0 turns off any maximum size threshold for that field.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- The <B>field_buffer</B> function returns NULL on error. It sets <B>errno</B>
+ The <STRONG>field_buffer</STRONG> function returns NULL on error. It sets <STRONG>errno</STRONG>
according to their success:
- <B>E_OK</B> The routine succeeded.
+ <STRONG>E_OK</STRONG> The routine succeeded.
- <B>E_BAD_ARGUMENT</B>
+ <STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argument.
- The <B>field_status</B> function returns <B>TRUE</B> or <B>FALSE</B>.
+ The <STRONG>field_status</STRONG> function returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>.
The remaining routines return one of the following:
- <B>E_OK</B> The routine succeeded.
+ <STRONG>E_OK</STRONG> The routine succeeded.
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno(3)</B>).
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno(3)</STRONG>).
- <B>E_BAD_ARGUMENT</B>
+ <STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argument.
-</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <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 <B><form.h></B> automatically includes the header file
-
- When configured for wide characters, <B>field_buffer</B> returns a pointer to
- temporary storage (allocated and freed by the library). The
+ When configured for wide characters, <STRONG>field_buffer</STRONG> returns a pointer to
+ temporary storage (allocated and freed by the library). The
application should not attempt to modify the data. It will be freed on
- the next call to <B>field_buffer</B> to return the same buffer. <B><curses.h></B>.
+ the next call to <STRONG>field_buffer</STRONG> to return the same buffer.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- These routines emulate the System V forms library. They were not
+ These routines emulate the System V forms library. They were not
supported on Version 7 or BSD versions.
- The <B>set_max_field</B> function checks for an ncurses extension
- <B>O_INPUT_FIELD</B> which allows a dynamic field to shrink if the new limit
+ The <STRONG>set_max_field</STRONG> function checks for an <EM>ncurses</EM> extension
+ <STRONG>O_INPUT_FIELD</STRONG> which allows a dynamic field to shrink if the new limit
is smaller than the current field size.
Raymond.
+</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
+ descriptions of the entry points.
+
- <B><A HREF="form_field_buffer.3X.html">form_field_buffer(3X)</A></B>
+
+ncurses 6.4 2024-03-16 <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
-<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
<li><a href="#h2-NOTES">NOTES</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
<li><a href="#h2-AUTHORS">AUTHORS</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
</ul>
</div>
</BODY>
projects / ncurses.git / blobdiff