From 82ba818ff456bcd6d56a06226e3f27e98fbb55c3 Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Thu, 14 Aug 2025 22:58:58 -0500 Subject: removing all downloaded devdocs files --- devdocs/c/string%2Fmultibyte%2Fmbsrtowcs.html | 79 --------------------------- 1 file changed, 79 deletions(-) delete mode 100644 devdocs/c/string%2Fmultibyte%2Fmbsrtowcs.html (limited to 'devdocs/c/string%2Fmultibyte%2Fmbsrtowcs.html') diff --git a/devdocs/c/string%2Fmultibyte%2Fmbsrtowcs.html b/devdocs/c/string%2Fmultibyte%2Fmbsrtowcs.html deleted file mode 100644 index 8154ac0a..00000000 --- a/devdocs/c/string%2Fmultibyte%2Fmbsrtowcs.html +++ /dev/null @@ -1,79 +0,0 @@ -

mbsrtowcs, mbsrtowcs_s

Defined in header <wchar.h>
(1) 
size_t mbsrtowcs( wchar_t* dst, const char** src, size_t len, mbstate_t* ps );
 -(since C95)
(until C99) -		 
size_t mbsrtowcs( wchar_t *restrict dst, const char **restrict src, size_t len,
-                  mbstate_t *restrict ps );
-		 (since C99) 
errno_t mbsrtowcs_s( size_t *restrict retval,
-                     wchar_t *restrict dst, rsize_t dstsz,
-                     const char **restrict src, rsize_t len,
-                     mbstate_t *restrict ps );
-		 (2) (since C11)
1) Converts a null-terminated multibyte character sequence, which begins in the conversion state described by *ps, from the array whose first element is pointed to by *src to its wide character representation. If dst is not null, converted characters are stored in the successive elements of the wchar_t array pointed to by dst. No more than len wide characters are written to the destination array. Each multibyte character is converted as if by a call to mbrtowc. The conversion stops if: 2) Same as (1), except that
-
-
    -
  • retval, ps, src, or *src is a null pointer
    • -
  • dstsz or len is greater than RSIZE_MAX/sizeof(wchar_t) (unless dst is null)
    • -
  • dstsz is not zero (unless dst is null)
    • -
  • There is no null character in the first dstsz multibyte characters in the *src array and len is greater than dstsz (unless dst is null)
    • -
-
As with all bounds-checked functions, mbsrtowcs_s only guaranteed to be available if __STDC_LIB_EXT1__ is defined by the implementation and if the user defines __STDC_WANT_LIB_EXT1__ to the integer constant 1 before including <wchar.h>.
-

Parameters

- - - - - - -
dst - pointer to wide character array where the results will be stored
src - pointer to pointer to the first element of a null-terminated multibyte string
len - number of wide characters available in the array pointed to by dst
ps - pointer to the conversion state object
dstsz - max number of wide characters that will be written (size of the dst array)
retval - pointer to a size_t object where the result will be stored

Return value

-1) On success, returns the number of wide characters, excluding the terminating L'\0', written to the character array. If dst is a null pointer, returns the number of wide characters that would have been written given unlimited length. On conversion error (if invalid multibyte character was encountered), returns (size_t)-1, stores EILSEQ in errno, and leaves *ps in unspecified state.
-2) zero on success (in which case the number of wide characters excluding terminating zero that were, or would be written to dst, is stored in *retval), non-sero on error. In case of a runtime constraint violation, stores (size_t)-1 in *retval (unless retval is null) and sets dst[0] to L'\0' (unless dst is null or dstmax is zero or greater than RSIZE_MAX)

Example

#include <stdio.h>
-#include <locale.h>
-#include <wchar.h>
-#include <string.h>
- 
-void print_as_wide(const char* mbstr)
-{
-    mbstate_t state;
-    memset(&state, 0, sizeof state);
-    size_t len = 1 + mbsrtowcs(NULL, &mbstr, 0, &state);
-    wchar_t wstr[len];
-    mbsrtowcs(&wstr[0], &mbstr, len, &state);
-    wprintf(L"Wide string: %ls \n", wstr);
-    wprintf(L"The length, including L'\\0': %zu\n", len);
-}
- 
-int main(void)
-{
-    setlocale(LC_ALL, "en_US.utf8");
-    print_as_wide(u8"z\u00df\u6c34\U0001f34c"); // u8"zß水🍌"
-}

Output:

-
Wide string: zß水🍌
-The length, including L'\0': 5

References

See also

- - - -
-
(C11)
 converts a narrow multibyte character string to wide string
(function)
-
(C95)
 converts the next multibyte character to wide character, given state
(function)
-
(C95)(C11)
 converts a wide string to narrow multibyte character string, given state
(function)
C++ documentation for mbsrtowcs
-

- © cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
- https://en.cppreference.com/w/c/string/multibyte/mbsrtowcs -

-
-- cgit v1.2.3