userptr(3form) [linux man page]

userptr(3FORM)															    userptr(3FORM)

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

       ncurses(3NCURSES), form(3FORM).

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.

AUTHORS

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

																    userptr(3FORM)

form_userptr(3CURSES)					     Curses Library Functions					     form_userptr(3CURSES)

NAME

       form_userptr, set_form_userptr - associate application data with forms

SYNOPSIS

       cc [ flag... ] file... -lform  -lcurses	[ library... ]
       #include <form.h>

       int set_form_userptr(FORM *form, char *ptr);

       char *form_userptr(FORM *form);

DESCRIPTION

       Every  form  has  an  associated  user  pointer that can be used to store pertinent data. set_form_userptr() sets the user pointer of form.
       form_userptr() returns the user pointer of form.

RETURN VALUES

       form_userptr() returns NULL on error. set_form_userptr() returns one of the following:

       E_OK		  The function returned successfully.

       E_SYSTEM_ERROR	  System error.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       curses(3CURSES), forms(3CURSES), attributes(5)

NOTES

       The header <form.h> automatically includes the headers  <eti.h> and <curses.h>.

SunOS 5.11							    31 Dec 1996 					     form_userptr(3CURSES)