X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmitem_new.3x;h=8e2449e2e2082eec83c31ee8f66e7ef44045319a;hp=0653840167bd5fba44d505d2db57951a8fb3602f;hb=21c8ffa0edf2e389f3f674f0c08009002c6f357d;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;ds=sidebyside diff --git a/man/mitem_new.3x b/man/mitem_new.3x index 06538401..8e2449e2 100644 --- a/man/mitem_new.3x +++ b/man/mitem_new.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_new.3x,v 1.7 1998/11/29 01:11:38 Rick.Ohnemus Exp $ +.\" $Id: mitem_new.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH mitem_new 3X "" .SH NAME -\fBmitem_new\fR - create and destroy menu items +\fBmitem_new\fR \- create and destroy menu items .SH SYNOPSIS \fB#include \fR .br @@ -42,7 +42,7 @@ int free_item(ITEM *item); The function \fBnew_item\fR allocates a new item and initializes it from the \fBname\fR and \fBdescription\fR pointers. Please notice that the item stores only the pointers to the name and description. Those pointers must be valid -during the lifetime of the item. So you should be very carefull with names +during the lifetime of the item. So you should be very careful with names or descriptions allocated on the stack of some routines. .br The function \fBfree_item\fR de-allocates an item. Please notice that it @@ -50,20 +50,27 @@ is the responsibility of the application to release the memory for the name or the description of the item. .SH RETURN VALUE The function \fBnew_item\fR returns \fBNULL\fR on error. - +It sets errno according to the function's failure: +.TP 5 +.B E_BAD_ARGUMENT +Routine detected an incorrect or out-of-range argument. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred, e.g., malloc failure. +.PP The function \fBfree_item\fR returns one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). -.TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_CONNECTED\fR +.B E_CONNECTED Item is connected to a menu. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES @@ -75,9 +82,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: