X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_info.3x.html;h=2090ab669cede7fd859350f0f5441dd2b2ec4225;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;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..2090ab66 100644 --- a/doc/html/man/form_field_info.3x.html +++ b/doc/html/man/form_field_info.3x.html @@ -1,82 +1,123 @@ + + +
+ + +- +form_field_info(3x) Library calls form_field_info(3x) --
- form_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, *max); +
+ dynamic_field_info, field_info - retrieve field characteristics --
- 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 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). +
+ #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 + 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 + 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. + + +
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(3)). - E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argument. --
- curses(3x) and 3x pages whose names begin "form_" for - detailed descriptions of the entry points. +
+ 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 + 2.7 does not. --
- The header file <form.h> automatically includes the header - file <curses.h>. +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. --
- 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 2.7 does not. +
+ curses(3x) and related pages whose names begin "form_" for detailed + descriptions of the entry points. + +ncurses 6.5 2024-03-16 form_field_info(3x)-
- Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. --