X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_new.3x;h=7a0178ac66c008f8c7dfd26de6d2ee12a6f9b951;hb=4c9f63c460cb7134f142aa65f6866c175ed77605;hp=ce52044f128052e50e03cf1d08aa3aca1073a18f;hpb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045;p=ncurses.git diff --git a/man/mitem_new.3x b/man/mitem_new.3x index ce52044f..7a0178ac 100644 --- a/man/mitem_new.3x +++ b/man/mitem_new.3x @@ -1,6 +1,6 @@ '\" 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 * @@ -28,21 +28,21 @@ .\" 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 $ .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 +\fBITEM *new_item(const char *\fIname\fB, const char *\fIdescription\fB);\fR .br -\fBint free_item(ITEM *\fP\fIitem\fP\fB);\fP +\fBint free_item(ITEM *\fIitem\fB);\fR .br .SH DESCRIPTION -The function \fBnew_item\fR allocates a new item and initializes it from the -\fBname\fR and \fBdescription\fR pointers. +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 @@ -50,12 +50,12 @@ 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. +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. +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 @@ -64,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. @@ -76,12 +76,12 @@ 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(3)). +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