usr/src/man/man3curses/panel_userptr.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH PANEL_USERPTR 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 panel_userptr, set_panel_userptr \- associate application data with a panels
  10 panel
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lpanel\fR \fB -lcurses \fR [ \fIlibrary\fR .. ]
  15 #include <panel.h>
  16
  17
  18
  19 \fBint\fR \fBset_panel_userptr\fR(\fBPANEL *\fR\fIpanel\fR, \fBchar *\fR\fIptr\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBchar *\fR \fBpanel_userptr\fR(\fBPANEL *\fR\fIpanel\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 Each panel has a user pointer available for maintaining relevant information.
  31 .sp
  32 .LP
  33 \fBset_panel_userptr()\fR sets the user pointer of \fIpanel\fR to \fIptr\fR.
  34 .sp
  35 .LP
  36 \fBpanel_userptr()\fR returns the user pointer of \fIpanel\fR.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 \fBset_panel_userptr\fR returns \fBOK\fR if successful, \fBERR\fR otherwise.
  41 .sp
  42 .LP
  43 \fBpanel_userptr\fR returns \fINULL\fR if there is no user pointer assigned to
  44 \fIpanel\fR.
  45 .SH ATTRIBUTES
  46 .sp
  47 .LP
  48 See \fBattributes\fR(5) for descriptions of the following attributes:
  49 .sp
  50
  51 .sp
  52 .TS
  53 box;
  54 c | c
  55 l | l .
  56 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  57 _
  58 MT-Level        Unsafe
  59 .TE
  60
  61 .SH SEE ALSO
  62 .sp
  63 .LP
  64 \fBcurses\fR(3CURSES), \fBpanels\fR(3CURSES), \fBattributes\fR(5)
  65 .SH NOTES
  66 .sp
  67 .LP
  68 The header \fB<panel.h>\fR automatically includes the header
  69 \fB<curses.h>\fR\&.