form_field_new(3) [netbsd man page]

FORMS(3)						   BSD Library Functions Manual 						  FORMS(3)

NAME

     dup_field, free_field, link_field, new_field -- form library

LIBRARY

     Curses Form Library (libform, -lform)

SYNOPSIS

     #include <form.h>

     FIELD *
     dup_field(FIELD *field, int frow, int fcol);

     int
     free_field(FIELD *field);

     FIELD *
     link_field(FIELD *field, int frow, int fcol);

     FIELD *
     new_field(int rows, int cols, int frow, int fcol, int nrows, int nbuf);

DESCRIPTION

     The dup_field() function duplicates the given field, including any buffers associated with the field and returns the pointer to the newly
     created field.  free_field() destroys the field and frees any allocated resources associated with the field.  The function link_field()
     copies the given field to a new field at the location frow and fcol but shares the buffers with the original field.  new_field() creates a
     new field of size rows by cols at location frow, fcol on the page, the argument nrows specified the number of off screen rows the field has
     and the nbuf parameter specifies the number of extra buffers attached to the field.  There will always be one buffer associated with a field.

RETURN VALUES

     On error dup_field() and new_field() will return NULL.  The functions will one of the following error values:

     E_OK		The function was successful.
     E_BAD_ARGUMENT	A bad argument was passed to the function.
     E_CONNECTED	The field is connected to a form.

SEE ALSO

     curses(3), forms(3)

NOTES

     The header <form.h> automatically includes both <curses.h> and <eti.h>.

BSD
								  January 1, 2001							       BSD

form_field_new(3CURSES) 				     Curses Library Functions					   form_field_new(3CURSES)

NAME

       form_field_new, new_field, dup_field, link_field, free_field - create and destroy forms fields

SYNOPSIS

       cc [ flag... ] file... -lform  -lcurses	[ library... ]
       #include <form.h>

       FIELD *new_field(int r, int c, int frow, int fcol, int nrow, int ncol);

       FIELD *dup_field(FIELD *field, int frow, int fcol);

       FIELD *link_field(FIELD *field, int frow, int fcol);

       int free_field(FIELD *field);

DESCRIPTION

       new_field()  creates  a new field with r rows and c columns, starting at frow, fcol, in the subwindow of a form. nrow is the number of off-
       screen rows and nbuf is the number of additional working buffers. This routine returns a pointer to the new field.

       dup_field() duplicates field at the specified location. All field attributes are duplicated, including the current contents  of	the  field
       buffers.

       link_field()  also duplicates field at the specified location. However, unlike dup_field(), the new field shares the field buffers with the
       original field. After creation, the attributes of the new field can be changed without affecting the original field.

       free_field() frees the storage allocated for field.

RETURN VALUES

       Routines that return pointers return NULL on error. free_field() returns one of the following:

       E_OK		 Thefunction returned successfully.

       E_CONNECTED	 The field is already connected to a form.

       E_SYSTEM_ERROR	 System error.

       E_BAD_ARGUMENT	 An argument is incorrect.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       curses(3CURSES), forms(3CURSES), attributes(5)

NOTES

       The header <form.h> automatically includes the headers  <eti.h> and <curses.h>.

SunOS 5.11							    31 Dec 1996 					   form_field_new(3CURSES)