form_field_userptr(3form)

form_field_userptr3form

Associate application data with a form field

Part of field_userptr(3form).

Usage

#include <form.h>
int set_field_userptr(FIELD *field, void*userptr);
void *field_userptr(const FIELD *field);

Overview

Every form field 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 that field.

Return value

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

The function set_field_userptr returns E_OK (success).

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.

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

Releases

7 releases since Debian 3.0 (Woody); the text changed 4 times.

  1. 3.0
  2. 3.1
  3. 4.0
  4. 5.0–6.0
  5. 7–8

Authors

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

From ncurses-doc 5.9+20140913-1+deb8u3 in Debian 8 (Jessie). Parsed by carta from the page's man source.