usr/src/man/man3curses/menu_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 MENU_USERPTR 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 menu_userptr, set_menu_userptr \- associate application data with menus
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lmenu\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  14 #include <menu.h>
  15
  16 \fBchar *\fR\fBmenu_userptr\fR(\fBMENU *\fR\fImenu\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBset_menu_userptr\fR(\fBMENU *\fR\fImenu\fR, \fBchar *\fR\fIuserptr\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 Every menu has an associated user pointer that can be used to store relevant
  28 information. \fBset_menu_userptr()\fR sets the user pointer of \fImenu\fR.
  29 \fBmenu_userptr()\fR returns the user pointer of \fImenu\fR.
  30 .SH RETURN VALUES
  31 .sp
  32 .LP
  33 \fBmenu_userptr()\fR returns \fINULL\fR on error.
  34 .sp
  35 .LP
  36 \fBset_menu_userptr()\fR returns one of the following:
  37 .sp
  38 .ne 2
  39 .na
  40 \fBE_OK\fR
  41 .ad
  42 .RS 18n
  43 The routine returned successfully.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fBE_SYSTEM_ERROR\fR
  50 .ad
  51 .RS 18n
  52 System error.
  53 .RE
  54
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 MT-Level        Unsafe
  69 .TE
  70
  71 .SH SEE ALSO
  72 .sp
  73 .LP
  74 \fBcurses\fR(3CURSES), \fBmenus\fR(3CURSES), \fBattributes\fR(5)
  75 .SH NOTES
  76 .sp
  77 .LP
  78 The header \fB<menu.h>\fR automatically includes the headers  \fB<eti.h>\fR and
  79 \fB<curses.h>\fR\&.