X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_info.3x;h=bde31285695104c572388a4ff58a9afdd3e4962f;hp=6165dd76479efe925806c1d76f37a06cdcf4d6d1;hb=41677b308e138027b7e435f741ee7fe5651237b0;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/man/form_field_info.3x b/man/form_field_info.3x index 6165dd76..bde31285 100644 --- a/man/form_field_info.3x +++ b/man/form_field_info.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2000 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2006 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,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_info.3x,v 1.6 2000/04/15 22:21:31 tom Exp $ +.\" $Id: form_field_info.3x,v 1.10 2006/11/04 17:14:31 tom Exp $ .TH form_field_info 3X "" .SH NAME \fBform_field_info\fR - retrieve field characteristics @@ -37,31 +37,32 @@ int field_info(const FIELD *field, int *rows, int *cols, int *frow, int *fcol, int *nrow, int *nbuf); .br -int dynamic_field_info(const FIELD *field, int *rows, int *cols, *max); +int dynamic_field_info(const FIELD *field, int *rows, int *cols, int *max); .br .SH DESCRIPTION The function \fBfield_info\fR 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. - +.PP The function \fBdynamic_field_info\fR 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 \fBO_STATIC\fR). +addressed by the third argument will be set to 0. +A field can be made dynamic +by turning off the \fBO_STATIC\fR option with \fBfield_opts_off\fR. .SH RETURN VALUE These routines return one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR +.B E_SYSTEM_ERROR System error occurred (see \fBerrno\fR). .TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .SH SEE ALSO -\fBcurses\fR(3X) and 3X 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