form_field_userptr(3X)                                form_field_userptr(3X)

NAME         top

       set_field_userptr,  field_userptr - associate application data with a
       form field

SYNOPSIS         top

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

DESCRIPTION         top

       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         top

       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).

SEE ALSO         top

       curses(3X), form(3X).

NOTES         top

       The header file <form.h> automatically includes the header file

PORTABILITY         top

       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.

AUTHORS         top

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

COLOPHON         top

       This page is part of the ncurses (new curses) project.  Information
       about the project can be found at 
       ⟨⟩.  If you have a
       bug report for this manual page, send it to  This page was obtained from the
       project's upstream Git mirror of the CVS repository 
       ⟨git://⟩ on 2017-03-13.  If you
       discover any rendering problems in this HTML version of the page, or
       you believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail