Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

form_sub(3) [netbsd man page]

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

form_sub, form_win, scale_form, set_form_sub, set_form_win -- form library LIBRARY
Curses Form Library (libform, -lform) SYNOPSIS
#include <form.h> WINDOW * form_sub(FORM *form); WINDOW * form_win(FORM *form); int scale_form(FORM *form, int *rows, int *cols); int set_form_sub(FORM *form, WINDOW *window); int set_form_win(FORM *form, WINDOW *window); DESCRIPTION
All output to the screen done by the forms library is handled by the curses library routines. By default, the forms library will output to the curses stdscr, but if the forms window has been set via set_form_win() then output will be sent to the window specified by set_form_win(), unless the forms subwindow has been set using set_form_sub(). If a subwindow has been specified using set_form_sub() then it will be used by the forms library to for screen output. The current setting for the form window can be retrieved by calling form_win(). If the forms window has not been set then NULL will be returned. Similarly, the forms subwindow can be found by calling the form_sub() func- tion, again, if the subwindow has not been set then NULL will be returned. The scale_form() function will return the minimum number of rows and columns that will entirely contain the given form. RETURN VALUES
Functions returning pointers will return NULL if an error is detected. The functions that return an int will return one of the following error values: E_OK The function was successful. E_NOT_CONNECTED The form has no fields connected to it. E_POSTED The form is posted to the screen. SEE ALSO
curses(3), forms(3) NOTES
The header <form.h> automatically includes both <curses.h> and <eti.h>. BSD
January 1, 2001 BSD

Check Out this Related Man Page

form_win(3CURSES)					     Curses Library Functions						 form_win(3CURSES)

form_win, set_form_win, set_form_sub, form_sub, scale_form - forms window and subwindow association routines SYNOPSIS
cc [ flag... ] file... -lform -lcurses [ library... ] #include <form.h> int set_form_win(FORM *form, WINDOW *win); WINDOW *form_win(FORM *form); int set_form_sub(FORM *form, WINDOW *sub); WINDOW *form_sub(FORM *form); int scale_form(FORM *form, int *rows, int *cols); DESCRIPTION
set_form_win() sets the window of form to win. form_win() returns a pointer to the window associated with form.set_form_sub() sets the sub- window of form to sub. form_sub() returns a pointer to the subwindow associated with form.scale_form() returns the smallest window size necessary for the subwindow of form. rows and cols are pointers to the locations used to return the number of rows and columns for the form. RETURN VALUES
Routines that return pointers always return NULL on error. Routines that return an integer return one of the following: E_OK The function returnedsuccessfully. E_SYSTEM_ERROR System error. E_BAD_ARGUMENT An argument is incorrect. E_NOT_CONNECTED The field is not connected to a form. E_POSTED The form is posted. 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_win(3CURSES)
Man Page