wcstombs(3int)

Name

wcstombs − converts a string of type wchar_t into a multibyte character string

Syntax

#include <stdlib.h>

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

Arguments

s The s argument is a pointer to the resulting multibyte character string.

pwcs The pwcs argument is a pointer to the source array of wide characters.

n The n argument is the maximum number of resulting bytes in the array pointed to by s.

Description

The wcstombs function converts a sequence of character codes of type wchar_t from the array pointed to by pwcs into a sequence of multibyte characters. The wcstombs function stores the multibyte characters in the array pointed to by s, stopping if a multibyte character would exceed the limit of n total bytes or if a null character is stored. Each character is converted as if by a call to the wctomb function. No more than n bytes are modified in the array pointed to by s. This function is affected by the LC_CTYPE category of the current locale.

Return Values

If a character is encountered that does not correspond to a valid multi-byte character, the wcstombs function returns (size_t)-1. Otherwise, the wcstombs function returns the number of bytes modified, not including a terminating null character, if any. The array will not be null-terminated if the value returned is n.

Museum