X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_info.3x.html;h=9ac316f6c3dab1e11f9cd8d6aaf4130b838ddf64;hp=44e0c55b7bf80f711b14f429882805ad57e1156e;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=cb4427a16794d98049b4d790b810d62217501f9f diff --git a/doc/html/man/form_field_info.3x.html b/doc/html/man/form_field_info.3x.html index 44e0c55b..9ac316f6 100644 --- a/doc/html/man/form_field_info.3x.html +++ b/doc/html/man/form_field_info.3x.html @@ -1,7 +1,8 @@ -
--form_field_info(3x) form_field_info(3x) +form_field_info(3X) form_field_info(3X)
- dynamic_field_info, field_info - retrieve field characteristics + dynamic_field_info, field_info - retrieve field characteristics
- #include <form.h> - 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); + #include <form.h> + + 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);
- The function field_info 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 field_info 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 dynamic_field_info returns the actual size of the field, - and its maximum possible size. If the field has no size limit, the + The function dynamic_field_info 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 O_STATIC option with field_opts_off. + be made dynamic by turning off the O_STATIC option with field_opts_off.
These routines return one of the following: - E_OK The routine succeeded. + E_OK The routine succeeded. - E_SYSTEM_ERROR - System error occurred (see errno(3)). + E_SYSTEM_ERROR + System error occurred (see errno(3)). - E_BAD_ARGUMENT + E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument.
- curses(3x) and related pages whose names begin "form_" for detailed + curses(3X) and related pages whose names begin "form_" for detailed descriptions of the entry points.
- The header file <form.h> automatically includes the header file - <curses.h>. + The header file <form.h> automatically includes the header file + <curses.h>.
- 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. @@ -107,7 +112,7 @@ - form_field_info(3x) + form_field_info(3X)