form_userptr()

NAME

form_userptr(), set_form_userptr() - associate application data with a form item

SYNOPSIS

#include <form.h>


int set_form_userptr(FORM *form, char *userptr);
char form_userptr(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(3) returns NULL on error.

The function set_form_userptr(3) returns one of the following:

E_OK

The routine succeeded.

E_SYSTEM_ERROR

System error occurred (see errno

SEE ALSO

curses(3)

forms(3)

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 should be a void pointer. We leave it as a char pointer for SVr4 compatibility.