lib/libmenu/menu_item_userptr.3

   1 .\"     $NetBSD: menu_item_userptr.3,v 1.6 2002/02/20 11:47:56 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_ITEM_USERPTR 3
  34 .Os
  35 .Sh NAME
  36 .Nm item_userptr ,
  37 .Nm set_item_userptr
  38 .Nd get or set user pointer for an item
  39 .Sh LIBRARY
  40 .Lb libmenu
  41 .Sh SYNOPSIS
  42 .In menu.h
  43 .Ft char *
  44 .Fn item_userptr "ITEM *item"
  45 .Ft int
  46 .Fn set_item_userptr "ITEM *item" "char *userptr"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn item_userptr
  50 function returns the value of the user defined pointer for the given
  51 item, this pointer is defined by the
  52 .Fn set_item_userptr
  53 function.
  54 .Sh RETURN VALUES
  55 The functions return one of the following error values:
  56 .Pp
  57 .Bl -tag -width E_SYSTEM_ERROR -compact
  58 .It Er E_OK
  59 The function was successful.
  60 .It Er E_SYSTEM_ERROR
  61 There was a system error during the call.
  62 .El
  63 .Sh SEE ALSO
  64 .Xr curses 3 ,
  65 .Xr menus 3
  66 .Sh NOTES
  67 The header
  68 .Pa \*[Lt]menu.h\*[Gt]
  69 automatically includes both
  70 .Pa \*[Lt]curses.h\*[Gt]
  71 and
  72 .Pa \*[Lt]eti.h\*[Gt] .