Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

wcstombs(3) [netbsd man page]

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

NAME
wcstombs -- converts a wide-character string to a multibyte 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); DESCRIPTION
wcstombs() converts the nul-terminated wide-character string pointed to by pwcs to the corresponding multibyte character string, and stores it in the array pointed to by s. This function may modify the first at most n bytes of the array pointed to by s. Each character will be converted as if wctomb(3) is continuously called, except the internal state of wctomb(3) will not be affected. For state-dependent encoding, the wcstombs() implies the result multibyte character string pointed to by s always to begin with an initial state. The behaviour of wcstombs() is affected by the LC_CTYPE category of the current locale. These are the special cases: s == NULL The wcstombs() returns the number of bytes to store the whole multibyte character string corresponding to the wide-character string pointed to by pwcs. In this case, n is ignored. pwcs == NULL Undefined (may cause the program to crash). RETURN VALUES
wcstombs() returns: 0 or positive Number of bytes stored in the array pointed to by s. There are no cases that the value returned is greater than n (unless s is a null pointer). If the return value is equal to n, the string pointed to by s will not be nul-terminated. (size_t)-1 pwcs points to a string containing an invalid wide character. wcstombs() also sets errno to indicate the error. ERRORS
wcstombs() may cause an error in the following case: [EILSEQ] pwcs points to a string containing an invalid wide character. SEE ALSO
mbstowcs(3), setlocale(3), wctomb(3) STANDARDS
The wcstombs() function conforms to ANSI X3.159-1989 (``ANSI C89''). The restrict qualifier is added at ISO/IEC 9899:1999 (``ISO C99''). BSD
March 16, 2011 BSD

Check Out this Related Man Page

mbstowcs(3C)						   Standard C Library Functions 					      mbstowcs(3C)

NAME
mbstowcs - convert a character string to a wide-character string SYNOPSIS
#include <stdlib.h> size_t mbstowcs(wchar_t *restrict pwcs, const char *restrict s, size_t n); DESCRIPTION
The mbstowcs() function converts a sequence of characters from the array pointed to by s into a sequence of corresponding wide-character codes and stores not more than n wide-character codes into the array pointed to by pwcs. No characters that follow a null byte (which is converted into a wide-character code with value 0) will be examined or converted. Each character is converted as if by a call to mbtowc(3C). No more than n elements will be modified in the array pointed to by pwcs. If copying takes place between objects that overlap, the behavior is undefined. The behavior of this function is affected by the LC_CTYPE category of the current locale. If pwcs is a null pointer, mbstowcs() returns the length required to convert the entire array regardless of the value of n, but no values are stored. RETURN VALUES
If an invalid character is encountered, mbstowcs() returns (size_t)-1 and may set errno to indicate the error. Otherwise, mbstowcs() returns the number of the array elements modified (or required if pwcs is NULL), not including a terminating 0 code, if any. The array will not be zero-terminated if the value returned is n. ERRORS
The mbstowcs() function may fail if: EILSEQ Invalid byte sequence is detected. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |CSI |Enabled | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
mblen(3C), mbtowc(3C), setlocale(3C), wcstombs(3C), wctomb(3C), attributes(5), standards(5) SunOS 5.10 1 Nov 2003 mbstowcs(3C)
Man Page