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

# [NAME](#NAME)

**form\_page** - set and get form page number

# [SYNOPSIS](#SYNOPSIS)

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

```
int set_current_field(FORM *form, FIELD *field);
FIELD *current_field(const FORM *form);
```

```
int unfocus_current_field(FORM *form);
```

```
int set_form_page(FORM *form, int n);
int form_page(const FORM *form);
```

```
int field_index(const FIELD *field);
```

# [DESCRIPTION](#DESCRIPTION)

The function **set\_current\_field** sets the current field of the given form; **current\_field** returns the current field of the given form.

The function **unfocus\_current\_field** removes the focus from the current field of the form. In such state, inquiries via **current\_field** shall return a *NULL* pointer.

The function **set\_form\_page** sets the form's page number (goes to page *n* of the form).

The function **form\_page** returns the form's current page number.

The function **field\_index** returns the index of the field in the field array of the form it is connected to. It returns **ERR** if the argument is the null pointer or the field is not connected.

# [RETURN VALUE](#RETURN_VALUE)

Except for **form\_page**, each routine returns one of the following:

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

The routine succeeded.

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

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

[**E\_BAD\_STATE**](#E_BAD_STATE)

Routine was called from an initialization or termination function.

[**E\_INVALID\_FIELD**](#E_INVALID_FIELD)

Contents of a field are not valid.

[**E\_REQUEST\_DENIED**](#E_REQUEST_DENIED)

The form driver could not process the request.

[**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 **unfocus\_current\_field** function is an *ncurses* extension.

# [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: set_current_field(3x) from ncurses 6.6.20261024-r0 (Chainguard OS)
Source: https://github.com/ThomasDickey/ncurses-snapshots