]> git.proxmox.com Git - mirror_edk2.git/blobdiff - StdLib/Include/wchar.h
ShellPkg/UefiShellDebug1CommandsLib: remove I/O address limit from 'mm'
[mirror_edk2.git] / StdLib / Include / wchar.h
index b53ee24939570a4855c08ad38aa20ebfe9c0945a..3acc2a4b8d99e9b268d4697edfc85e89bfa7f555 100644 (file)
               - WEOF might not be negative.\r
               - mbstate_t objects are not intended to be inspected by programs.\r
 \r
-    Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\r
+    Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
     This program and the accompanying materials are licensed and made available under\r
     the terms and conditions of the BSD License that accompanies this distribution.\r
     The full text of the license may be found at\r
@@ -1089,7 +1089,7 @@ by the value of base, and a final wide string of one or more unrecognized wide
 characters, including the terminating null wide character of the input wide string. Then,\r
 they attempt to convert the subject sequence to an integer, and return the result.\r
 \r
-    @param[in]  Nptr    Pointer to the string to convert to a floating-point value.\r
+    @param[in]  Nptr    Pointer to the string to convert.\r
     @param[in]  EndPtr  Optional pointer to an object in which to store a pointer\r
                         to the final wide string.\r
     @param[in]  Base    Base, 0 to 36, of the value represented by the string\r
@@ -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