[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 13/14] man/curs_bkgd.3x: Clarify return values.
From: |
G. Branden Robinson |
Subject: |
[PATCH 13/14] man/curs_bkgd.3x: Clarify return values. |
Date: |
Fri, 1 Dec 2023 17:33:58 -0600 |
* Say when `getbkgd()` returns `ERR`.
* Correct `wbkgd()` `ERR` case.
* Move text about what XSI Curses specifies for errors to "PORTABILITY"
section, dropping duplicate sentence along the way.
---
man/curs_bkgd.3x | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/man/curs_bkgd.3x b/man/curs_bkgd.3x
index 1b922acf..3125620f 100644
--- a/man/curs_bkgd.3x
+++ b/man/curs_bkgd.3x
@@ -131,12 +131,10 @@ .SS getbkgd
The \fBgetbkgd\fP function returns the given window's current background
character/attribute pair.
.SH RETURN VALUE
-These functions are described in the XSI Curses standard, Issue 4.
-It specifies that \fBbkgd\fP and \fBwbkgd\fP return \fBERR\fP on failure,
-but gives no failure conditions.
-.PP
-The routines \fBbkgd\fP and \fBwbkgd\fP return the integer \fBOK\fP,
-unless the library has not been initialized.
+Functions returning an \fIint\fP return \fBOK\fP on success.
+\fB\%bkgd\fP returns \fBERR\fP if the library has not been initialized.
+\fB\%wbkgd\fP and \fB\%getbkgd\fP return \fBERR\fP if the \fI\%WINDOW\fP
+pointer argument is null.
.PP
In contrast,
the SVr4.0 manual says \fBbkgd\fP and \fBwbkgd\fP may return \fBOK\fP
@@ -160,6 +158,10 @@ .SH NOTES
and will reuse the old background character if the check fails.
.SH PORTABILITY
These functions are described in the XSI Curses standard, Issue 4.
+It specifies that \fBbkgd\fP and \fBwbkgd\fP return \fBERR\fP on
+failure,
+but gives no failure conditions.
+.PP
.SH SEE ALSO
\fB\%curses\fP(3X),
\fB\%curs_addch\fP(3X),
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 13/14] man/curs_bkgd.3x: Clarify return values.,
G. Branden Robinson <=