X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fform_userptr.3x;h=11c990c0030b4403819cc95c6bd02e2ae448cb5d;hb=HEAD;hp=bd29b542c85b6695005aa9bd2ee8d5b834da296f;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96;p=ncurses.git diff --git a/man/form_userptr.3x b/man/form_userptr.3x index bd29b542..11c990c0 100644 --- a/man/form_userptr.3x +++ b/man/form_userptr.3x @@ -1,6 +1,6 @@ -'\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2023,2024 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,37 +27,38 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_userptr.3x,v 1.13 2010/12/04 18:40:45 tom Exp $ -.TH form_userptr 3X "" +.\" $Id: form_userptr.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH form_userptr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME -\fBform_userptr\fR \- associate application data with a form item +\fBset_form_userptr\fP, +\fBform_userptr\fP \- +associate application data with a form item .SH SYNOPSIS -\fB#include \fR -.br -int set_form_userptr(FORM *form, void *userptr); -.br -void* form_userptr(const FORM *form); -.br +.nf +\fB#include +.PP +\fBint set_form_userptr(FORM *\fIform\fP, void *\fIuserptr\fP); +\fBvoid* form_userptr(const FORM *\fIform\fP); +.fi .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 a pointer (which may be \fBNULL\fR). -It does not set errno. +The function \fBform_userptr\fP returns a pointer (which may be \fBNULL\fP). +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. +The function \fBset_form_userptr\fP returns \fBE_OK\fP (success). .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. .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. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X)