***************************************************************************
Copyright 2018-2023,2024 Thomas E. Dickey *
Copyright 1998-2010,2015 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 *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: mitem_new.3x,v 1.36 2024/03/16 15:35:01 tom Exp $
new_item, free_item - create and destroy menu items

#include <menu.h>

ITEM *new_item(const char *name, const char *description);
int free_item(ITEM *item);

The function new_item allocates a new item and initializes it from the name and description 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 careful with names or descriptions allocated on the stack of some routines.

The function free_item de-allocates an item. Please notice that it is the responsibility of the application to release the memory for the name or the description of the item.

The function new_item returns NULL on error. It sets errno according to the function's failure:

5 E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument.

5 E_SYSTEM_ERROR System error occurred, e.g., malloc failure.

The function free_item returns one of the following:

5 E_OK The routine succeeded.

5 E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument.

5 E_CONNECTED Item is connected to a menu.

5 E_SYSTEM_ERROR System error occurred (see errno(3)).

These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. \%curses(3X), \%menu(3X)