View Source: wcstombs(3) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages

WCSTOMBS
!!!WCSTOMBS
NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
CONFORMING TO
SEE ALSO
NOTES
----
!!NAME


wcstombs - convert a wide character string to a multibyte string
!!SYNOPSIS


__#include
__''dest''__, const wchar_t *__''src''__, size_t__ ''n''__);
__
!!DESCRIPTION


If ''dest'' is not a NULL pointer, the __wcstombs__
function converts the wide-character string ''src'' to a
multibyte string starting at ''dest''. At most ''n''
bytes are written to ''dest''. The conversion starts in
the initial state. The conversion can stop for three
reasons:


1. A wide character has been encountered that can not be
represented as a multibyte sequence (according to the
current locale). In this case (size_t)(-1) is
returned.


2. The length limit forces a stop. In this case the number
of bytes written to ''dest'' is returned, but the shift
state at this point is lost.


3. The wide-character string has been completely converted,
including the terminating L'0'. In this case the conversion
ends in the initial state. The number of bytes written to
''dest'', excluding the terminating '0' byte, is
returned.


The programmer must ensure that there is room for at least
''n'' bytes at ''dest''.


If ''dest'' is NULL, ''n'' is ignored, and the
conversion proceeds as above, except that the converted
bytes are not written out to memory, and that no length
limit exists.


In order to avoid the case 2 above, the programmer should
make sure ''n'' is greater or equal to
''wcstombs(NULL,src,0)+1''.
!!RETURN VALUE


The __wcstombs__ function returns the number of bytes
that make up the converted part of multibyte sequence, not
including the terminating null byte. If a wide character was
encountered which could not be converted, (size_t)(-1) is
returned.
!!CONFORMING TO


ISO/ANSI C, UNIX98
!!SEE ALSO


wcsrtombs(3)
!!NOTES


The behaviour of __wcstombs__ depends on the LC_CTYPE
category of the current locale.


The function __wcsrtombs__ provides a thread safe
interface to the same functionality.
----

4 pages link to wcstombs(3):

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

Last edited on Tuesday, June 4, 2002 12:24:41 am by "perry"

Edit PageHistory Diff Info LikePages