<!--
* t
****************************************************************************
- * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 2018-2021,2022 Thomas E. Dickey *
* Copyright 1998-2010,2015 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: mitem_new.3x,v 1.19 2020/10/18 00:37:03 tom Exp @
+ * @Id: mitem_new.3x,v 1.22 2022/02/12 20:02:20 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>mitem_new 3X</TITLE>
+<TITLE>mitem_new 3x</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
</HEAD>
<BODY>
-<H1 class="no-header">mitem_new 3X</H1>
+<H1 class="no-header">mitem_new 3x</H1>
<PRE>
-<B><A HREF="mitem_new.3X.html">mitem_new(3X)</A></B> <B><A HREF="mitem_new.3X.html">mitem_new(3X)</A></B>
+<STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG> <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <B>new_item</B>, <B>free_item</B> - create and destroy menu items
+ <STRONG>new_item</STRONG>, <STRONG>free_item</STRONG> - create and destroy menu items
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <B>#include</B> <B><menu.h></B>
+ <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
- <B>ITEM</B> <B>*new_item(const</B> <B>char</B> <B>*</B><I>name</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>description</I><B>);</B>
- <B>int</B> <B>free_item(ITEM</B> <B>*</B><I>item</I><B>);</B>
+ <STRONG>ITEM</STRONG> <STRONG>*new_item(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>name</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>description</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>free_item(ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The function <B>new_item</B> allocates a new item and initializes it from the
- <B>name</B> and <B>description</B> pointers. Please notice that the item stores only
+ The function <STRONG>new_item</STRONG> allocates a new item and initializes it from the
+ <STRONG>name</STRONG> and <STRONG>description</STRONG> 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 <B>free_item</B> de-allocates an item. Please notice that it is
+ The function <STRONG>free_item</STRONG> 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.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- The function <B>new_item</B> returns <B>NULL</B> on error. It sets <B>errno</B> according
+ The function <STRONG>new_item</STRONG> returns <STRONG>NULL</STRONG> on error. It sets <STRONG>errno</STRONG> according
to the function's failure:
- <B>E_BAD_ARGUMENT</B>
+ <STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argument.
- <B>E_SYSTEM_ERROR</B>
+ <STRONG>E_SYSTEM_ERROR</STRONG>
System error occurred, e.g., malloc failure.
- The function <B>free_item</B> returns one of the following:
+ The function <STRONG>free_item</STRONG> returns one of the following:
- <B>E_OK</B> The routine succeeded.
+ <STRONG>E_OK</STRONG> The routine succeeded.
- <B>E_BAD_ARGUMENT</B>
+ <STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argument.
- <B>E_CONNECTED</B>
+ <STRONG>E_CONNECTED</STRONG>
Item is connected to a menu.
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno(3)</B>).
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno(3)</STRONG>).
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- The header file <B><menu.h></B> automatically includes the header file
- <B><curses.h></B>.
+ The header file <STRONG><menu.h></STRONG> automatically includes the header file
+ <STRONG><curses.h></STRONG>.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- <B><A HREF="mitem_new.3X.html">mitem_new(3X)</A></B>
+ <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff