form_field_userptr(3x) [freebsd man page]

form_field_userptr(3X)													    form_field_userptr(3X)

NAME

       form_field_userptr - associate application data with a form field

SYNOPSIS

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

DESCRIPTION

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

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

															    form_field_userptr(3X)

form_field_userptr(3CURSES)				     Curses Library Functions				       form_field_userptr(3CURSES)

NAME

       form_field_userptr, set_field_userptr, field_userptr - associate application data with forms

SYNOPSIS

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

       int set_field_userptr(FIELD *field, char *ptr);

       char *field_userptr(FIELD *field);

DESCRIPTION

       Every  field  has  an associated user pointer that can be used to store pertinent data. set_field_userptr() sets the user pointer of field.
       field_userptr() returns the user pointer of field.

RETURN VALUES

       field_userptr() returns NULL on error. set_field_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_field_userptr(3CURSES)