iOS Manual Pages

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

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

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  NULL  on  error.   The  function
       set_form_userptr returns one of the following:

       E_OK The routine succeeded.

       E_SYSTEM_ERROR
            System error occurred (see errno).

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 sup-ported supported
       ported on Version 7 or BSD versions.

       The user pointer should be a void pointer.   We  leave  it  as  a  char
       pointer for SVr4 compatibility.

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



                                                              form_userptr(3X)