Libc-391.tar.gz

[apple/libc.git] / locale / FreeBSD / mbsrtowcs.3.patch

--- mbsrtowcs.3.orig	Fri Mar 11 18:09:42 2005
+++ mbsrtowcs.3	Fri Mar 11 18:11:17 2005
@@ -28,7 +28,9 @@
 .Os
 .Sh NAME
 .Nm mbsrtowcs ,
-.Nm mbsnrtowcs
+.Nm mbsnrtowcs ,
+.Nm mbsrtowcs_l ,
+.Nm mbsnrtowcs_l
 .Nd "convert a character string to a wide-character string (restartable)"
 .Sh LIBRARY
 .Lb libc
@@ -44,6 +46,17 @@
 .Fa "wchar_t * restrict dst" "const char ** restrict src" "size_t nms"
 .Fa "size_t len" "mbstate_t * restrict ps"
 .Fc
+.In xlocale.h
+.Ft size_t
+.Fo mbsrtowcs_l
+.Fa "wchar_t * restrict dst" "const char ** restrict src" "size_t len"
+.Fa "mbstate_t * restrict ps" "locale_t loc"
+.Fc
+.Ft size_t
+.Fo mbsnrtowcs_l
+.Fa "wchar_t * restrict dst" "const char ** restrict src" "size_t nms"
+.Fa "size_t len" "mbstate_t * restrict ps" "locale_t loc"
+.Fc
 .Sh DESCRIPTION
 The
 .Fn mbsrtowcs
@@ -97,6 +110,18 @@
 .Fa nms
 bytes from the buffer pointed to by 
 .Fa src .
+.Pp
+While the
+.Fn mbsrtowcs
+and
+.Fn mbsnrtowcs
+functions use the current locale, the
+.Fn mbsrtowcs_l
+and
+.Fn mbsnrtowcs_l
+functions may be passed locales directly. See
+.Xr xlocale 3
+for more information.
 .Sh RETURN VALUES
 The
 .Fn mbsrtowcs
@@ -123,7 +148,8 @@
 .Xr mbrtowc 3 ,
 .Xr mbstowcs 3 ,
 .Xr multibyte 3 ,
-.Xr wcsrtombs 3
+.Xr wcsrtombs 3 ,
+.Xr xlocale 3
 .Sh STANDARDS
 The
 .Fn mbsrtowcs