mbsrtowcs(3): Clarify the RETURN VALUES section

PR:		215848
Submitted by:	Andrew Stevenson <andrew at ugh dot net dot au>
MFC after:	1 week
This commit is contained in:
Gordon Bergling 2020-08-07 16:56:43 +00:00
parent 33176cdc87
commit 90fb6afc55
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=364031

View File

@ -23,7 +23,7 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.Dd July 21, 2004
.Dd August 7, 2020
.Dt MBSRTOWCS 3
.Os
.Sh NAME
@ -98,15 +98,29 @@ except that conversion stops after reading at most
bytes from the buffer pointed to by
.Fa src .
.Sh RETURN VALUES
The
If successful, and
.Fa dst
is not NULL, the
.Fn mbsrtowcs
and
.Fn mbsnrtowcs
functions return the number of wide characters stored in
the array pointed to by
.Fa dst .
.Pp
If
.Fa dst
if successful, otherwise it returns
.Po Vt size_t Pc Ns \-1 .
was NULL then the functions
.Fn mbsrtowcs
and
.Fn mbsnrtowcs
return the number of wide characters that would have been stored where
.Fa dst
points to an infinitely large array.
.Pp
If either one of the functions is not successful then
.Po Vt size_t Pc Ns \-1
is returned.
.Sh ERRORS
The
.Fn mbsrtowcs