Mac Developer Library Developer


This manual page is part of Xcode Tools version 5.0

To obtain these tools:

If you are running a version of Xcode Tools other than 5.0, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • To learn how the manual is organized or to learn about command syntax, read the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Developer Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.

MBSTOWCS(3)              BSD Library Functions Manual              MBSTOWCS(3)

     mbstowcs, mbstowcs_l -- convert a character string to a wide-character string

     Standard C Library (libc, -lc)

     #include <stdlib.h>

     mbstowcs(wchar_t *restrict pwcs, const char *restrict s, size_t n);

     #include <stdlib.h>
     #include <xlocale.h>

     mbstowcs_l(wchar_t *restrict pwcs, const char *restrict s, size_t n, locale_t loc);

     The mbstowcs() function converts a multibyte character string s, beginning in the initial conversion
     state, into a wide character string pwcs.  No more than n wide characters are stored.  A terminating
     null wide character is appended, if there is room.

     Although the mbstowcs() function uses the current locale, the mbstowcs_l() function may be passed a
     locale directly. See xlocale(3) for more information.

     The mbstowcs() function returns the number of wide characters converted, not counting any terminating
     null wide character, or -1 if an invalid multibyte character was encountered.

     The mbstowcs() function will fail if:

     [EILSEQ]           An invalid multibyte sequence was detected.

     [EINVAL]           The conversion state is invalid.

     mbsrtowcs(3), mbtowc(3), multibyte(3), xlocale(3)

     The mbstowcs() function conforms to ISO/IEC 9899:1999 (``ISO C99'').

BSD                              April 8, 2004                             BSD

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.