X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_userptr.3x.html;h=4586087355c9a57b77bc6769ffaef1429f454759;hp=503275e78cad1b43855d73858118dbab6452bb7b;hb=2a32bee362db64f5a06b2124976b928ac3faa578;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/doc/html/man/form_userptr.3x.html b/doc/html/man/form_userptr.3x.html index 503275e7..45860873 100644 --- a/doc/html/man/form_userptr.3x.html +++ b/doc/html/man/form_userptr.3x.html @@ -1,8 +1,7 @@ - +
+ +- form_userptr(3x) form_userptr(3x) --
- form_userptr - associate application data with a form item +
+ set_form_userptr, form_userptr - associate application + data with a form item --
+
#include <form.h> int set_form_userptr(FORM *form, void *userptr); void* form_userptr(const FORM *form); --
+
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. --
- The function form_userptr returns NULL on error. The - function set_form_userptr returns one of the following: - - E_OK The routine succeeded. +
+ The function form_userptr returns a pointer (which may be + NULL). It does not set errno. - E_SYSTEM_ERROR - System error occurred (see errno). + The function set_form_userptr returns E_OK (success). --
+
curses(3x), form(3x). --
+
The header file <form.h> automatically includes the header file <curses.h>. --
+
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. + The user pointer is a void pointer. We chose not to leave + it as a char pointer for SVr4 compatibility. --
+
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. @@ -106,10 +96,17 @@ form_userptr(3x)-