form\_field(3X) Library calls form\_field(3X)

# [NAME](#NAME)

**form\_field** - make and break connections between fields and forms

# [SYNOPSIS](#SYNOPSIS)

```
#include <form.h>
```

```
int set_form_fields(FORM *form, FIELD **fields);
FIELD **form_fields(const FORM *form);
int field_count(const FORM *form);
int move_field(FIELD *field, int frow, int fcol);
```

# [DESCRIPTION](#DESCRIPTION)

The function **set\_form\_fields** changes the field pointer array of the given *form*. The array must be terminated by a *NULL*.

The function **form\_fields** returns the field array of the given form.

The function **field\_count** returns the count of fields in *form*.

The function **move\_field** moves the given field (which must be disconnected) to a specified location on the screen.

# [RETURN VALUE](#RETURN_VALUE)

The function **form\_fields** returns a pointer (which may be *NULL*). It does not set **errno**.

The function **field\_count** returns **ERR** if the *form* parameter is *NULL*.

The functions **set\_form\_fields** and **move\_field** return one of the following codes on error:

[**E\_OK**](#E_OK)

The routine succeeded.

[**E\_BAD\_ARGUMENT**](#E_BAD_ARGUMENT)

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

[**E\_CONNECTED**](#E_CONNECTED)

The field is already connected to a form.

[**E\_POSTED**](#E_POSTED)

The form is already posted.

[**E\_SYSTEM\_ERROR**](#E_SYSTEM_ERROR)

System error occurred (see [**errno**(3)](/man/os/ncurses/errno.3)).

# [PORTABILITY](#PORTABILITY)

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

The SVr4 forms library documentation specifies the **field\_count** error value as -1 (which is the value of **ERR**).

# [AUTHORS](#AUTHORS)

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

# [SEE ALSO](#SEE_ALSO)

[**curses**(3X)](/man/os/ncurses/curses.3X), [**form**(3X)](/man/os/ncurses/form.3X)

2024-12-28 ncurses 6.6

---

Document: form_fields(3x) from ncurses 6.6.20261024-r0 (Chainguard OS)
Source: https://github.com/ThomasDickey/ncurses-snapshots