form_field_info()

retrieve field characteristics 

Curses Function


SYNOPSIS

#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);


DESCRIPTION

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).


RETURN VALUES

These routines return one of the following:

E_OK 

The routine succeeded.

E_SYSTEM_ERROR 

System error occurred.

E_BAD_ARGUMENT 

Routine detected an incorrect or out-of-range argument.


NOTES

The header file <form.h> automatically includes the header file <curses.h>.


PORTABILITY

These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.


AUTHORS

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.


AVAILABILITY

PTC MKS Toolkit for Professional Developers
PTC MKS Toolkit for Enterprise Developers
PTC MKS Toolkit for Enterprise Developers 64-Bit Edition


SEE ALSO

Functions:
curses(), form_cursor(), form_data(), form_driver(), form_field(), form_field_attributes(), form_field_buffer(), form_field_just(), form_field_new(), form_field_opts(), form_field_userptr(), form_field_validation(), form_fieldtype(), form_hook(), form_new(), form_new_page(), form_opts(), form_page(), form_post(), form_requestname(), form_userptr(), form_win()


PTC MKS Toolkit 10.1 Documentation Build 15.