X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fmitem_new.3x.html;h=be9151ba70d68693694c9387d27e4bc3011d78ab;hb=HEAD;hp=9918f6cf908626a219cf9e5f55acd69042f4c275;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/mitem_new.3x.html b/doc/html/man/mitem_new.3x.html index 9918f6cf..b4ed6676 100644 --- a/doc/html/man/mitem_new.3x.html +++ b/doc/html/man/mitem_new.3x.html @@ -1,82 +1,124 @@ + + +
+ + +- +mitem_new(3x) Library calls mitem_new(3x) --
- mitem_new - create and destroy menu items --
- #include <menu.h> - ITEM *new_item(const char *name, const char *description); - int free_item(ITEM *item); +
+ new_item, free_item - create and destroy menu items --
- 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 life- - time of the item. So you should be very carefull with - names or descriptions allocated on the stack of some rou- - tines. - 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. +
+ #include <menu.h> --
- The function new_item returns NULL on error. + 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 free_item returns one of the following: - E_OK The routine succeeded. +
+ The function new_item returns NULL on error. It sets errno according + to the function's failure: - E_SYSTEM_ERROR - System error occurred (see errno). + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argument. - E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. + E_SYSTEM_ERROR + System error occurred, e.g., malloc failure. - E_CONNECTED + The function free_item returns one of the following: + + E_OK The routine succeeded. + + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argument. + + E_CONNECTED Item is connected to a menu. + E_SYSTEM_ERROR + System error occurred (see errno(3)). --
- curses(3x), menu(3x). +
+ These routines emulate the System V menu library. They were not + supported on Version 7 or BSD versions. --
- The header file <menu.h> automatically includes the header - file <curses.h>. +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. --
- These routines emulate the System V menu library. They - were not supported on Version 7 or BSD versions. +
+ curses(3x), menu(3x) --
- Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +ncurses 6.5 2024-03-16 mitem_new(3x)-