Mac Developer Library Developer
Search

 

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.




WCSTOMBS(3)              BSD Library Functions Manual              WCSTOMBS(3)

NAME
     wcstombs, wcstombs_l -- convert a wide-character string to a character string

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     #include <stdlib.h>

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

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

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

DESCRIPTION
     The wcstombs() function converts a wide character string pwcs into a multibyte character string, s,
     beginning in the initial conversion state.  Up to n bytes are stored in s.  Partial multibyte charac-ters characters
     ters at the end of the string are not stored.  The multibyte character string is null terminated, if
     there is room.

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

RETURN VALUES
     The wcstombs() function returns the number of bytes converted (not including any terminating null), if
     successful; otherwise, it returns (size_t)-1.

ERRORS
     The wcstombs() function will fail if:

     [EILSEQ]           An invalid wide character was encountered.

     [EINVAL]           The conversion state is invalid.

SEE ALSO
     mbstowcs(3), multibyte(3), wcsrtombs(3), wctomb(3), xlocale(3)

STANDARDS
     The wcstombs() 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.

Feedback