userptr(3form)

userptr3form

Associate application data with a form item

Usage

#include <form.h>

int set_form_userptr(FORM *form, void *userptr); void* form_userptr(const FORM *form);

Overview

Every form and every form item has a field that can be used to hold application-specific data (that is, the form-driver code leaves it alone). These functions get and set the form user pointer field.

Return value

The function form_userptr returns a pointer (which may be NULL). It does not set errno.

The function set_form_userptr returns E_OK (success).

Portability

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

The user pointer is a void pointer. We chose not to leave it as a char pointer for SVr4 compatibility.

Releases

18 releases since Debian 1.1 (Buzz); the text changed 13 times.

  1. 1.1–1.3
  2. 2.0
  3. 2.1
  4. 2.2
  5. 3.0
  6. 3.1
  7. 4.0
  8. 5.0–6.0
  9. 7–8
  10. 9
  11. 10
  12. 11
  13. 12
  14. 13

Authors

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

From ncurses-doc 6.5+20250216-2 in Debian 13 (Trixie). Parsed by carta from the page's man source.