~ubuntu-branches/ubuntu/natty/ncurses/natty

« back to all changes in this revision

Viewing changes to man/menu_new.3x

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-05-17 09:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517090042-86fgxrr6j5jzagot
Tags: 5.6-0ubuntu1
* New upstream version.
  - Remove patches applied upstream: ncurses.upstream, signed-chars.
  - Update patches: debian-backspace.
* Build-depend on g++-multilib instead of lib{32,64}c*-dev-*.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
'\" t
2
2
.\"***************************************************************************
3
 
.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
 
3
.\" Copyright (c) 1998,2006 Free Software Foundation, Inc.                   *
4
4
.\"                                                                          *
5
5
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
6
6
.\" copy of this software and associated documentation files (the            *
27
27
.\" authorization.                                                           *
28
28
.\"***************************************************************************
29
29
.\"
30
 
.\" $Id: menu_new.3x,v 1.7 1998/11/29 01:10:13 Rick.Ohnemus Exp $
 
30
.\" $Id: menu_new.3x,v 1.9 2006/11/04 18:31:37 tom Exp $
31
31
.TH menu_new 3X ""
32
32
.SH NAME
33
33
\fBmenu_new\fR - create and destroy menus
41
41
.SH DESCRIPTION
42
42
The function \fBnew_menu\fR creates a new menu connected to a specified item
43
43
pointer array (which must be \fBNULL\fR-terminated).
44
 
 
 
44
.PP
45
45
The function \fBfree_menu\fR disconnects \fImenu\fR from its item array
46
46
and frees the storage allocated for the menu.
47
47
.SH RETURN VALUE
48
48
The function \fBnew_menu\fR returns \fBNULL\fR on error.
49
 
 
 
49
It sets errno according to the function's failure:
 
50
.TP 5
 
51
.B E_NOT_CONNECTED
 
52
No items are connected to the menu.
 
53
.TP 5
 
54
.B E_SYSTEM_ERROR
 
55
System error occurred, e.g., malloc failure.
 
56
.PP
50
57
The function \fBfree_menu\fR returns one of the following:
51
58
.TP 5
52
 
\fBE_OK\fR
 
59
.B E_OK
53
60
The routine succeeded.
54
61
.TP 5
55
 
\fBE_SYSTEM_ERROR\fR
 
62
.B E_SYSTEM_ERROR
56
63
System error occurred (see \fBerrno\fR).
57
64
.TP 5
58
 
\fBE_BAD_ARGUMENT\fR
 
65
.B E_BAD_ARGUMENT
59
66
Routine detected an incorrect or out-of-range argument.
60
67
.TP 5
61
 
\fBE_POSTED\fR
 
68
.B E_POSTED
62
69
The menu has already been posted.
63
70
.SH SEE ALSO
64
71
\fBcurses\fR(3X), \fBmenu\fR(3X).