lib/libmenu/menu_userptr.3

   1 .\"     $NetBSD: menu_userptr.3,v 1.7 2002/10/01 19:27:00 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1999
   4 .\"     Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
   5 .\"
   6 .\" This code is donated to The NetBSD Foundation by the author.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. The name of the Author may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior written
  18 .\"    permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd September 10, 1999
  33 .Dt MENU_USERPTR 3
  34 .Os
  35 .Sh NAME
  36 .Nm menu_userptr ,
  37 .Nm set_menu_userptr
  38 .Nd get or set user pointer for a menu
  39 .Sh LIBRARY
  40 .Lb libmenu
  41 .Sh SYNOPSIS
  42 .In menu.h
  43 .Ft char *
  44 .Fn menu_userptr "MENU *menu"
  45 .Ft int
  46 .Fn set_menu_userptr "MENU *menu" "char *ptr"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn menu_userptr
  50 function returns the pointer to the user defined pointer for the given
  51 menu.
  52 This pointer is set by the
  53 .Fn set_menu_userptr
  54 function.
  55 .Sh RETURN VALUES
  56 The functions return one of the following error values:
  57 .Pp
  58 .Bl -tag -width E_SYSTEM_ERROR -compact
  59 .It Er E_OK
  60 The function was successful.
  61 .It Er E_SYSTEM_ERROR
  62 There was a system error during the call.
  63 .El
  64 .Sh SEE ALSO
  65 .Xr curses 3 ,
  66 .Xr menus 3
  67 .Sh NOTES
  68 The header
  69 .Pa \*[Lt]menu.h\*[Gt]
  70 automatically includes both
  71 .Pa \*[Lt]curses.h\*[Gt]
  72 and
  73 .Pa \*[Lt]eti.h\*[Gt] .