This manual page is for Mac OS X version 10.6

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.


form_userptr(3X)                                                                            form_userptr(3X)



NAME
       form_userptr - associate application data with a form item

SYNOPSIS
       #include <form.h>
       int set_form_userptr(FORM *form, void *userptr);
       void* form_userptr(const FORM *form);

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

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

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 ver-sions. versions.
       sions.

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

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



                                                                                            form_userptr(3X)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.