X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fform_userptr.3x.html;h=a5033f79f476a350e7f034552aedd77c06bfcbf2;hb=16fbf3f4f7d96b6ee6bf9159b22f26e05962aa3d;hp=4ac76f8bbe5171f1b890a19ce77b4799d75a5b91;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/form_userptr.3x.html b/doc/html/man/form_userptr.3x.html index 4ac76f8b..a5033f79 100644 --- a/doc/html/man/form_userptr.3x.html +++ b/doc/html/man/form_userptr.3x.html @@ -1,82 +1,113 @@ + + +
+ + +- +form_userptr(3x) form_userptr(3x) --
- 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); +
+ set_form_userptr, form_userptr - associate application data with a form + item --
- 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. +
+ #include <form.h> --
- The function form_userptr returns NULL on error. The - function set_form_userptr returns one of the following: + int set_form_userptr(FORM *form, void *userptr); + void* form_userptr(const FORM *form); - E_OK The routine succeeded. - - E_SYSTEM_ERROR - System error occurred (see errno). - - --
- curses(3x), form(3x). +
+ 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 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. - - --
- Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +
+ 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). +
+ 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 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. + form_userptr(3x)-