X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmitem_new.3x.html;h=6c1685f095cdaaaa8bef0f39c5a39e8b8e63b37b;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hp=1a527080bfeef3a03fc8870617c3988fdb2c70d9;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b;p=ncurses.git diff --git a/doc/html/man/mitem_new.3x.html b/doc/html/man/mitem_new.3x.html index 1a527080..6c1685f0 100644 --- a/doc/html/man/mitem_new.3x.html +++ b/doc/html/man/mitem_new.3x.html @@ -1,7 +1,8 @@ -
--mitem_new(3x) mitem_new(3x) +mitem_new(3X) mitem_new(3X)
- new_item, free_item - create and destroy menu items + 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); + #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 + 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 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 + The function new_item returns NULL on error. It sets errno according to the function's failure: - E_BAD_ARGUMENT + E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. - E_SYSTEM_ERROR + E_SYSTEM_ERROR System error occurred, e.g., malloc failure. - The function free_item returns one of the following: + The function free_item returns one of the following: - E_OK The routine succeeded. + E_OK The routine succeeded. - E_BAD_ARGUMENT + E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. - E_CONNECTED + E_CONNECTED Item is connected to a menu. - E_SYSTEM_ERROR - System error occurred (see errno). + E_SYSTEM_ERROR + System error occurred (see errno(3)).
- curses(3x), menu(3x). + curses(3X), menu(3X).
- The header file <menu.h> automatically includes the header file - <curses.h>. + The header file <menu.h> automatically includes the header file + <curses.h>.
- These routines emulate the System V menu library. They were not sup- - ported on Version 7 or BSD versions. + These routines emulate the System V menu library. They were not + supported on Version 7 or BSD versions.
@@ -111,7 +113,7 @@ - mitem_new(3x) + mitem_new(3X)