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

NAME

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

SYNOPSIS

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

DESCRIPTION

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

RETURN VALUE

49       The wcsrtombs() function returns the number of bytes that make  up  the
50       converted  part  of  multibyte  sequence, not including the terminating
51       null byte.  If a wide character was encountered which could not be con‐
52       verted, (size_t)(-1) is returned, and errno set to EILSEQ.
53

CONFORMING TO

55       C99.
56

SEE ALSO

58       iconv(3), wcsnrtombs(3), wcstombs(3)
59

NOTES

61       The  behaviour  of  wcsrtombs() depends on the LC_CTYPE category of the
62       current locale.
63
64       Passing NULL as ps is not multi-thread safe.
65
66
67
68GNU                               1999-07-25                      WCSRTOMBS(3)