X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmitem_new.3x.html;h=58ceafa7afec319988a06bceb0d1ce7677f4286c;hp=9918f6cf908626a219cf9e5f55acd69042f4c275;hb=a919b0ee00a6287c7e29330be52f9bb557503288;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/mitem_new.3x.html b/doc/html/man/mitem_new.3x.html index 9918f6cf..58ceafa7 100644 --- a/doc/html/man/mitem_new.3x.html +++ b/doc/html/man/mitem_new.3x.html @@ -1,82 +1,141 @@ + + +
+ + +- +mitem_new(3x) mitem_new(3x) + + +-
- mitem_new - create and destroy menu items +NAME
+ mitem_new - create and destroy menu items-SYNOPSIS
- #include <menu.h> +SYNOPSIS
+ #include <menu.h> ITEM *new_item(const char *name, const char *description); int free_item(ITEM *item);-DESCRIPTION
- 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
+ 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.-RETURN VALUE
- The function new_item returns NULL on error. +RETURN VALUE
+ 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_OK The routine succeeded. + E_SYSTEM_ERROR + System error occurred, e.g., malloc failure. - E_SYSTEM_ERROR - System error occurred (see errno). + The function free_item returns one of the following: - E_BAD_ARGUMENT + E_OK The routine succeeded. + + 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). +-SEE ALSO
- curses(3x), menu(3x). +SEE ALSO
+ curses(3x), menu(3x).-NOTES
- The header file <menu.h> automatically includes the header - file <curses.h>. +NOTES
+ The header file <menu.h> automatically includes the header + file <curses.h>.-PORTABILITY
+PORTABILITY
These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions.-AUTHORS
+AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. + + mitem_new(3x)-
- -Man(1) output converted with -man2html - +