X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_userptr.3x.html;h=deba2ffe5b5bf000cbc4ceadef42b8841f29ed46;hp=4ac76f8bbe5171f1b890a19ce77b4799d75a5b91;hb=b11cef1e315b58820ea0cde239ebf2f741ef8948;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/form_userptr.3x.html b/doc/html/man/form_userptr.3x.html index 4ac76f8b..deba2ffe 100644 --- a/doc/html/man/form_userptr.3x.html +++ b/doc/html/man/form_userptr.3x.html @@ -1,22 +1,66 @@ + + +
+ + +- +form_userptr(3x) form_userptr(3x) + + +-
- form_userptr - associate application data with a form item +NAME
+ set_form_userptr, form_userptr - associate application + data with a form item-SYNOPSIS
- #include <form.h> +SYNOPSIS
+ #include <form.h> int set_form_userptr(FORM *form, void *userptr); void* form_userptr(const FORM *form);-DESCRIPTION
+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 @@ -24,59 +68,53 @@-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. +RETURN VALUE
+ 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).-SEE ALSO
- curses(3x), form(3x). +SEE ALSO
+ curses(3x), form(3x).-NOTES
- The header file <form.h> automatically includes the header - file <curses.h>. +NOTES
+ The header file <form.h> automatically includes the header + file <curses.h>.-PORTABILITY
+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. + The user pointer is a void pointer. We chose not to leave + it as a char pointer for SVr4 compatibility.-AUTHORS
+AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. - - - - - - - - - - - + form_userptr(3x)-
- -Man(1) output converted with -man2html - +