Author: gbe (doc committer) Date: Fri Aug 7 16:56:43 2020 New Revision: 364031 URL: https://svnweb.freebsd.org/changeset/base/364031
Log: mbsrtowcs(3): Clarify the RETURN VALUES section PR: 215848 Submitted by: Andrew Stevenson <andrew at ugh dot net dot au> MFC after: 1 week Modified: head/lib/libc/locale/mbsrtowcs.3 Modified: head/lib/libc/locale/mbsrtowcs.3 ============================================================================== --- head/lib/libc/locale/mbsrtowcs.3 Fri Aug 7 16:26:56 2020 (r364030) +++ head/lib/libc/locale/mbsrtowcs.3 Fri Aug 7 16:56:43 2020 (r364031) @@ -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 _______________________________________________ svn-src-head@freebsd.org mailing list https://lists.freebsd.org/mailman/listinfo/svn-src-head To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"
