te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
FORM_WIN 3CURSES "Dec 31, 1996"
NAME
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 subwindow 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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

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

NOTES

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