X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=inline;f=doc%2Fhtml%2Fman%2Fform_field_info.3x.html;h=498fc2941ddda2eecdb2e1481ea83b23bfe64369;hb=37babca07fea18b480155ef60ef302ca09fca152;hp=40ef3a2d801a1814e24728cc554c98c4d1c04841;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/form_field_info.3x.html b/doc/html/man/form_field_info.3x.html index 40ef3a2d..498fc294 100644 --- a/doc/html/man/form_field_info.3x.html +++ b/doc/html/man/form_field_info.3x.html @@ -1,61 +1,104 @@ + + +
++form_field_info(3x) form_field_info(3x) + + +
- form_field_info - retrieve field characteristics + form_field_info - retrieve field characteristics
- #include <form.h> + #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, *max); + *cols, int *max);
- The function field_info returns the sizes and other + 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 cor- ner, 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 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). + argument will be set to 0. A field can 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). + E_SYSTEM_ERROR + System error occurred (see errno). - E_BAD_ARGUMENT + E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argu- ment.
- curses(3x) and 3x pages whose names begin "form_" for + 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>.@@ -72,6 +115,10 @@
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. + + + + form_field_info(3x)