ADC Home > Reference Library > Reference > Mac OS X > Mac OS X Man Pages
|
This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles. For more information about the manual page format, see the manual page for manpages(5). |
MBSTOWCS(3) BSD Library Functions Manual MBSTOWCS(3) NAME mbstowcs, mbstowcs_l -- convert a character string to a wide-character string LIBRARY Standard C Library (libc, -lc) SYNOPSIS #include <stdlib.h> size_t mbstowcs(wchar_t *restrict pwcs, const char *restrict s, size_t n); #include <stdlib.h> #include <xlocale.h> size_t mbstowcs_l(wchar_t *restrict pwcs, const char *restrict s, size_t n, locale_t loc); DESCRIPTION The mbstowcs() function converts a multibyte character string s, begin-ning beginning ning in the initial conversion state, into a wide character string pwcs. No more than n wide characters are stored. A terminating null wide char-acter character acter 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. RETURN VALUES 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. ERRORS The mbstowcs() function will fail if: [EILSEQ] An invalid multibyte sequence was detected. [EINVAL] The conversion state is invalid. SEE ALSO mbsrtowcs(3), mbtowc(3), multibyte(3), xlocale(3) STANDARDS The mbstowcs() function conforms to ISO/IEC 9899:1999 (``ISO C99''). BSD April 8, 2004 BSD |