X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmitem_new.3x.html;h=927c3d075e4887010ad3bb0525f68b7e13e0abe5;hp=9918f6cf908626a219cf9e5f55acd69042f4c275;hb=761e4f0825b330e970558e82a4bd638383914429;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/mitem_new.3x.html b/doc/html/man/mitem_new.3x.html index 9918f6cf..927c3d07 100644 --- a/doc/html/man/mitem_new.3x.html +++ b/doc/html/man/mitem_new.3x.html @@ -1,30 +1,72 @@ + + +
++mitem_new(3x) mitem_new(3x) + + +
- mitem_new - create and destroy menu items + mitem_new - create and destroy menu items
- #include <menu.h> + #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 + 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 + time 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. @@ -32,32 +74,40 @@
- The function new_item returns NULL on error. + The function new_item returns NULL on error. It sets + errno according to the function's failure: - The function free_item returns one of the following: + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argu- + ment. + + E_SYSTEM_ERROR + System error occurred, e.g., malloc failure. - E_OK The routine succeeded. + The function free_item returns one of the following: - E_SYSTEM_ERROR - System error occurred (see errno). + E_OK The routine succeeded. - E_BAD_ARGUMENT + E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argu- ment. - E_CONNECTED + E_CONNECTED Item is connected to a menu. + E_SYSTEM_ERROR + System error occurred (see errno). +
- 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>.@@ -72,6 +122,8 @@ curses by Eric S. Raymond. + + mitem_new(3x)