X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_userptr.3x.html;h=de534a8953c1a86b150e7c3557f6dc26e0d416ad;hb=8e397cccba0aad135cb9a8a353756f4273a7cdf6;hp=46977c9ffcc535a0f8621ec942796fb810183e5e;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/form_field_userptr.3x.html b/doc/html/man/form_field_userptr.3x.html index 46977c9f..de534a89 100644 --- a/doc/html/man/form_field_userptr.3x.html +++ b/doc/html/man/form_field_userptr.3x.html @@ -1,82 +1,111 @@ + + +
+ + +- +form_field_userptr(3x) form_field_userptr(3x) --
- form_field_userptr - associate application data with a - form field --
- #include <form.h> + +
+ set_field_userptr, field_userptr - associate application + data with a form field + + +
+ #include <form.h> int set_field_userptr(FIELD *field, void*userptr); void *field_userptr(const FIELD *field); --
+
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. --
- The function field_userptr returns NULL on error. The - function set_field_userptr returns one of the following: - - E_OK The routine succeeded. +
+ The function field_userptr returns a pointer (which may be + NULL). It does not set errno. - E_SYSTEM_ERROR - System error occurred (see errno). + The function set_field_userptr returns E_OK (success). --
- curses(3x), form(3x). +
+ curses(3x), form(3x). --
- The header file <form.h> automatically includes the header - file <curses.h>. +
+ The header file <form.h> automatically includes the header + file <curses.h>. --
- These routines emulate the System V forms library. They +
+ 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 +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. - - - - - - - - - - - + form_field_userptr(3x)-