---
name: "form_win"
section: "3x"
platform: "macos"
package: "ncurses"
version: "79"
release: "macOS 26.5"
platforms: ["linux", "macos"]
url: "https://new.carta.tech/form_win/3x"
---

# form\_win(3x)

make and break form window and subwindow associations

## NAME

**form\_win** - make and break form window and subwindow associations

## SYNOPSIS

**#include \<form.h\>**\
 int set\_form\_win(FORM \*form, WINDOW \*win);\
 WINDOW \*form\_win(const FORM \*form);\
 int set\_form\_sub(FORM \*form, WINDOW \*sub);\
 WINDOW \*form\_sub(const FORM \*form);\
 int scale\_form(const FORM \*form, int \*rows, int \*columns);\

## DESCRIPTION

Every form has an associated pair of **curses** windows.  The form window displays any title and border associated with the window; the form subwindow displays the items of the form that are currently available for selection.

The first four functions get and set those windows.  It is not necessary to set either window; by default, the driver code uses **stdscr** for both.

In the **set\_** functions, window argument of **NULL** is treated as though it were **stsdcr**.  A form argument of **NULL** is treated as a request to change the system default form window or subwindow.

The function **scale\_form** returns the minimum size required for the subwindow of *form*.

## RETURN VALUE

Routines that return pointers return **NULL** on error.  Routines that return an integer return one of the following error codes:

- **E\_OK**

  The routine succeeded.

- **E\_SYSTEM\_ERROR**

  System error occurred (see **errno**).

- **E\_BAD\_ARGUMENT**

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

- **E\_POSTED**

  The form has already been posted.

- **E\_NOT\_CONNECTED**

  No items are connected to the form.

## SEE ALSO

**curses**(3X), **curs\_variables**(3X), **form**(3X).

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