X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_new.3x;h=616e23c8223798681aba2495cc8ca5923b37427d;hb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;hp=d234c370a52fa44b396d5c9637544fa23289aa4a;hpb=b11cef1e315b58820ea0cde239ebf2f741ef8948;p=ncurses.git diff --git a/man/mitem_new.3x b/man/mitem_new.3x index d234c370..616e23c8 100644 --- a/man/mitem_new.3x +++ b/man/mitem_new.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc. * +.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,31 +28,35 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_new.3x,v 1.13 2015/12/05 23:42:45 tom Exp $ +.\" $Id: mitem_new.3x,v 1.21 2021/12/25 21:49:32 tom Exp $ .TH mitem_new 3X "" .SH NAME \fBnew_item\fP, -\fBfree_item\fR \- create and destroy menu items +\fBfree_item\fP \- create and destroy menu items .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBITEM *new_item(const char *\fP\fIname\fP\fB, const char *\fP\fIdescription\fP\fB);\fP .br -ITEM *new_item(const char *name, const char *description); -.br -int free_item(ITEM *item); +\fBint free_item(ITEM *\fP\fIitem\fP\fB);\fP .br .SH DESCRIPTION -The function \fBnew_item\fR allocates a new item and initializes it from the -\fBname\fR and \fBdescription\fR 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 +The function \fBnew_item\fP allocates a new item and initializes it from the +\fBname\fP and \fBdescription\fP 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. .br -The function \fBfree_item\fR de-allocates an item. Please notice that it +The function \fBfree_item\fP 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. .SH RETURN VALUE -The function \fBnew_item\fR returns \fBNULL\fR on error. -It sets errno according to the function's failure: +The function \fBnew_item\fP returns \fBNULL\fP on error. +It sets \fBerrno\fP according to the function's failure: .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. @@ -59,7 +64,7 @@ Routine detected an incorrect or out-of-range argument. .B E_SYSTEM_ERROR System error occurred, e.g., malloc failure. .PP -The function \fBfree_item\fR returns one of the following: +The function \fBfree_item\fP returns one of the following: .TP 5 .B E_OK The routine succeeded. @@ -71,15 +76,16 @@ Routine detected an incorrect or out-of-range argument. Item is connected to a menu. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fP(3)). .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fP(3X), \fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +These routines emulate the System V menu library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.