*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->FreeBSD man pages -> form_field_new (3)              
Title
Content
Arch
Section
 

form_field_new(3X)

Contents


NAME    [Toc]    [Back]

       form_field_new - create and destroy form fields

SYNOPSIS    [Toc]    [Back]

       #include <form.h>
       FIELD *new_field(int height, int width,
			int toprow, int leftcol,
			int offscreen, int nbuffers);
       FIELD *dup_field(FIELD *field, int toprow, int leftcol);
       FIELD *link_field(FIELD *field, int toprow, int leftcol);
       int free_field(FIELD *field);

DESCRIPTION    [Toc]    [Back]

       The  function  new_field  allocates a new field and initializes it from
       the parameters given: height, width, row of upper-left  corner,	column
       of  upper-left corner, number off-screen rows, and number of additional
       working buffers.

       The function dup_field duplicates a field  at  a  new  location.   Most
       attributes  (including  current contents, size, validation type, buffer
       count, growth threshold,  justification,  foreground,  background,  pad
       character, options, and user pointer) are copied.  Field status and the
       field page bit are not copied.

       The function link_field acts like dup_field, but the new  field	shares
       buffers with its parent.  Attribute data is separate.

       The function free_field de-allocates storage associated with a field.

RETURN VALUE    [Toc]    [Back]

       The function, new_field, dup_field, link_field return NULL on error.

       The function free_field returns one of the following:

       E_OK The routine succeeded.

       E_SYSTEM_ERROR    [Toc]    [Back]
	    System error occurred (see errno).

       E_BAD_ARGUMENT    [Toc]    [Back]
	    Routine detected an incorrect or out-of-range argument.

SEE ALSO    [Toc]    [Back]

      
      
       curses(3X), form(3X).

NOTES    [Toc]    [Back]

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

PORTABILITY    [Toc]    [Back]

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

       It  may	be  unwise  to	count  on  the	set  of  attributes  copied by
       dup_field(3X) being portable; the System V forms library documents  are
       not very explicit on what gets copied and was not.

AUTHORS    [Toc]    [Back]

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



							    form_field_new(3X)
[ Back ]
 Similar pages
Name OS Title
set_field_pad FreeBSD color and attribute control for form fields
set_field_fore FreeBSD color and attribute control for form fields
set_field_pad OpenBSD color and attribute control for form fields
set_field_fore OpenBSD color and attribute control for form fields
form_field_attributes OpenBSD color and attribute control for form fields
field_pad FreeBSD color and attribute control for form fields
field_fore FreeBSD color and attribute control for form fields
field_back FreeBSD color and attribute control for form fields
field_pad OpenBSD color and attribute control for form fields
set_field_back FreeBSD color and attribute control for form fields
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service