form_field(3X)

💖 form_field — make and break connections between fields and forms 💖

okay so bestie, this is the form_field(3X) library-calls page, and it's literally about hooking fields up to forms and unhooking them. no cap, every fact is still here — just with main-character energy. 💅

✨ NAME ✨

form_field — make and break connections between fields and forms

🌸 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 🦋

• set_form_fields — changes the field pointer array of the given form. the array must be terminated by a NULL. periodt.
• form_fields — returns the field array of the given form.
• field_count — returns the count of fields in form.
• move_field — moves the given field (which must be disconnected) to a specified location on the screen. iykyk, disconnected is the vibe check here.

👑 RETURN VALUE 👑

• form_fields returns a pointer (which may be NULL). it does not set errno. not me checking errno for no reason 💀
• field_count returns ERR if the form parameter is NULL.
• set_form_fields and move_field return one of the following codes on error:
  • E_OK — the routine succeeded.
  • E_BAD_ARGUMENT — the routine detected an incorrect or out-of-range argument.
  • E_CONNECTED — the field is already connected to a form.
  • E_POSTED — the form is already posted.
  • E_SYSTEM_ERROR — a system error occurred (see errno(3)).

🌈 PORTABILITY 🌈

These routines emulate the System V forms library. they were not supported on Version 7 or BSD versions. fr fr, that's the lore.

The SVr4 forms library documentation specifies the field_count error value as -1 (which is the value of ERR). lowkey iconic. ✨

💜 AUTHORS 💜

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. giving credit where credit is due 🫶

🎀 SEE ALSO 🎀

curses(3X), form(3X)

🌸 xoxo, your form_field(3X) bestie — this page is from ncurses 6.5, dated 2024-12-28 💖