X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_buffer.3x;h=98b2e42dc831bb3356e7b9b090adbede5b20e445;hp=749f24c56a5a0b1c020110a819175676b4cfe9f9;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72 diff --git a/man/form_field_buffer.3x b/man/form_field_buffer.3x index 749f24c5..98b2e42d 100644 --- a/man/form_field_buffer.3x +++ b/man/form_field_buffer.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2017,2018 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2017 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 * @@ -27,8 +28,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_buffer.3x,v 1.21 2018/07/28 21:34:06 tom Exp $ +.\" $Id: form_field_buffer.3x,v 1.27 2020/10/24 09:27:17 tom Exp $ .TH form_field_buffer 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 @@ -38,15 +43,15 @@ .SH SYNOPSIS \fB#include \fR .sp -int set_field_buffer(FIELD *field, int buf, const char *value); +\fBint set_field_buffer(FIELD *\fP\fIfield\fP\fB, int \fP\fIbuf\fP\fB, const char *\fP\fIvalue\fP\fB);\fP .br -char *field_buffer(const FIELD *field, int buffer); -.br -int set_field_status(FIELD *field, bool status); -.br -bool field_status(const FIELD *field); +\fBchar *field_buffer(const FIELD *\fP\fIfield\fP\fB, int \fP\fIbuffer\fP\fB);\fP +.sp +\fBint set_field_status(FIELD *\fP\fIfield\fP\fB, bool \fP\fIstatus\fP\fB);\fP .br -int set_max_field(FIELD *field, int max); +\fBbool field_status(const FIELD *\fP\fIfield\fP\fB);\fP +.sp +\fBint set_max_field(FIELD *\fP\fIfield\fP\fB, int \fP\fImax\fP\fB);\fP .br .SH DESCRIPTION The function \fBset_field_buffer\fR sets the numbered buffer of the given field @@ -94,7 +99,7 @@ The function \fBset_max_field\fR sets the maximum size for a dynamic field. An argument of 0 turns off any maximum size threshold for that field. .SH RETURN VALUE The \fBfield_buffer\fR function returns NULL on error. -It sets errno according to their success: +It sets \fBerrno\fP according to their success: .TP 5 .B E_OK The routine succeeded. @@ -110,12 +115,12 @@ The remaining routines return one of the following: The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fR(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .SH SEE ALSO -\fBcurses\fR(3X) and related pages whose names begin "form_" for detailed +\fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed descriptions of the entry points. .SH NOTES The header file \fB\fR automatically includes the header file @@ -130,6 +135,10 @@ same buffer. These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. +.PP +The \fBset_max_field\fP function checks for an ncurses extension +\fBO_INPUT_FIELD\fP which allows a dynamic field to shrink if the new +limit is smaller than the current field size. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.