StdLib/Include: Minor changes in preparation for Interactive I/O (TTY) functionality.

[mirror_edk2.git] / StdLib / Include / wchar.h

diff --git a/StdLib/Include/wchar.h b/StdLib/Include/wchar.h
index b53ee24939570a4855c08ad38aa20ebfe9c0945a..2c9ec6e5e784417174c862b107e003747a78abdb 100644 (file)
--- a/StdLib/Include/wchar.h
+++ b/StdLib/Include/wchar.h
@@ -1415,10 +1415,16 @@ int mbsinit(const mbstate_t *ps);
     where internal is the mbstate_t object for the mbrlen function, except that\r
     the expression designated by ps is evaluated only once.\r
 \r
-    @return   The mbrlen function returns a value between zero and n,\r
-              inclusive, (size_t)(-2), or (size_t)(-1).\r
+    @param[in]  s     Pointer to a multibyte character sequence.\r
+    @param[in]  n     Maximum number of bytes to examine.\r
+    @param[in]  pS    Pointer to the conversion state object.\r
+\r
+    @retval   0       The next n or fewer characters complete a NUL.\r
+    @retval   1..n    The number of bytes that complete the multibyte character.\r
+    @retval   -2      The next n bytes contribute to an incomplete (but potentially valid) multibyte character.\r
+    @retval   -1      An encoding error occurred.\r
 **/\r
-size_t mbrlen(const char * __restrict S, size_t n, mbstate_t * __restrict ps);\r
+size_t mbrlen(const char * __restrict S, size_t n, mbstate_t * __restrict pS);\r
 \r
 /** Restartable Multibyte to Wide character conversion.\r
 If S is a null pointer, the mbrtowc function is equivalent to the call:<BR>\r