Manpage of WCSTOMBS

WCSTOMBS

Section: Linux Programmer's Manual (3)
Updated: 2015-08-08
Index
 

NAME

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

SYNOPSIS

#include <stdlib.h>size_t wcstombs(char *dest, const wchar_t *src, size_t n);
 

DESCRIPTION

If destis not NULL, the wcstombs() function converts the wide-character string srcto a multibyte string starting at dest. At most nbytes 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) -1is returned.

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

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

The programmer must ensure that there is room for at least nbytes at dest.

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

In order to avoid the case 2 above, the programmer should make sure nis greater than 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 a multibyte sequence, not including the terminating null byte. If a wide character was encountered which could not be converted, (size_t) -1is returned.  

ATTRIBUTES

For an explanation of the terms used in this section, see attributes(7).
InterfaceAttributeValue
wcstombs() Thread safetyMT-Safe

 

CONFORMING TO

POSIX.1-2001, POSIX.1-2008, C99.  

NOTES

The behavior of wcstombs() depends on the LC_CTYPEcategory of the current locale.

The function wcsrtombs(3) provides a thread safe interface to the same functionality.  

SEE ALSO

mblen(3), mbtowc(3), mbstowcs(3), wcsrtombs(3) wctom(3)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ATTRIBUTES
CONFORMING TO
NOTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 22:27:59 GMT, June 20, 2016 Click Here!