X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_userptr.3x;h=5651a95f57e1f719f13b0cf3b61473764848f07d;hp=00e3d71aa40e8be660e7b01b3642cbd49bcbfa26;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/form_userptr.3x b/man/form_userptr.3x index 00e3d71a..5651a95f 100644 --- a/man/form_userptr.3x +++ b/man/form_userptr.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,47 +28,39 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_userptr.3x,v 1.9 1998/11/29 01:08:39 Rick.Ohnemus Exp $ +.\" $Id: form_userptr.3x,v 1.19 2020/10/24 09:00:52 tom Exp $ .TH form_userptr 3X "" .SH NAME -\fBform_userptr\fR - associate application data with a form item +\fBset_form_userptr\fP, +\fBform_userptr\fR \- associate application data with a form item .SH SYNOPSIS \fB#include \fR +.sp +\fBint set_form_userptr(FORM *\fP\fIform\fP\fB, void *\fP\fIuserptr\fP\fB);\fP .br -int set_form_userptr(FORM *form, void *userptr); -.br -void* form_userptr(const FORM *form); +\fBvoid* form_userptr(const FORM *\fP\fIform\fP\fB);\fP .br .SH 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. .SH RETURN VALUE -The function \fBform_userptr\fR returns \fBNULL\fR on error. -The function \fBset_form_userptr\fR returns one of the following: -.TP 5 -\fBE_OK\fR -The routine succeeded. -.TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +The function \fBform_userptr\fR returns a pointer (which may be \fBNULL\fR). +It does not set \fBerrno\fP. +.PP +The function \fBset_form_userptr\fR returns \fBE_OK\fP (success). .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +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. +.PP +The user pointer is a void pointer. +We chose not to leave it as a char pointer for SVr4 compatibility. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.