mbsrtowcs(3)

1MBSRTOWCS(3)               Linux Programmer's Manual              MBSRTOWCS(3)
2
3
4

NAME

6       mbsrtowcs - convert a multibyte string to a wide-character string
7

SYNOPSIS

9       #include <wchar.h>
10
11       size_t mbsrtowcs(wchar_t *dest, const char **src,
12                         size_t len, mbstate_t *ps);
13

DESCRIPTION

15       If  dest  is  not NULL, the mbsrtowcs() function converts the multibyte
16       string *src to a wide-character string starting at dest.  At  most  len
17       wide  characters  are written to dest.  The shift state *ps is updated.
18       The conversion is effectively  performed  by  repeatedly  calling  mbr‐
19       towc(dest,  *src,  n,  ps)  where n is some positive number, as long as
20       this call succeeds, and then incrementing dest by one and *src  by  the
21       number of bytes consumed.  The conversion can stop for three reasons:
22
23       1. An  invalid  multibyte sequence has been encountered.  In this case,
24          *src is left pointing to the invalid multibyte sequence, (size_t) -1
25          is returned, and errno is set to EILSEQ.
26
27       2. len  non-L'\0'  wide  characters  have been stored at dest.  In this
28          case, *src is left pointing to the next  multibyte  sequence  to  be
29          converted,  and  the  number  of  wide characters written to dest is
30          returned.
31
32       3. The multibyte string has been completely  converted,  including  the
33          terminating null wide character ('\0'), which has the side effect of
34          bringing back *ps to the initial state.  In this case, *src  is  set
35          to  NULL, and the number of wide characters written to dest, exclud‐
36          ing the terminating null wide character, is returned.
37
38       If dest is NULL, len is ignored, and the conversion proceeds as  above,
39       except  that  the converted wide characters are not written out to mem‐
40       ory, and that no length limit exists.
41
42       In both of the above cases, if ps is NULL,  a  static  anonymous  state
43       known only to the mbsrtowcs() function is used instead.
44
45       The  programmer  must  ensure  that there is room for at least len wide
46       characters at dest.
47

RETURN VALUE

49       The mbsrtowcs() function returns the number  of  wide  characters  that
50       make  up the converted part of the wide-character string, not including
51       the terminating null wide character.  If an invalid multibyte  sequence
52       was encountered, (size_t) -1 is returned, and errno set to EILSEQ.
53

ATTRIBUTES

55       For   an   explanation   of   the  terms  used  in  this  section,  see
56       attributes(7).
57
58       ┌────────────┬───────────────┬──────────────────────────────┐
59       │Interface   │ Attribute     │ Value                        │
60       ├────────────┼───────────────┼──────────────────────────────┤
61       │mbsrtowcs() │ Thread safety │ MT-Unsafe race:mbsrtowcs/!ps │
62       └────────────┴───────────────┴──────────────────────────────┘
63

CONFORMING TO

65       POSIX.1-2001, POSIX.1-2008, C99.
66

NOTES

68       The behavior of mbsrtowcs() depends on the  LC_CTYPE  category  of  the
69       current locale.
70
71       Passing NULL as ps is not multithread safe.
72

COLOPHON

77       This  page  is  part of release 5.02 of the Linux man-pages project.  A
78       description of the project, information about reporting bugs,  and  the
79       latest     version     of     this    page,    can    be    found    at
80       https://www.kernel.org/doc/man-pages/.
81
82
83
84GNU                               2019-03-06                      MBSRTOWCS(3)