mbstowcs(3int)

Name

mbstowcs − converts a sequence of multibyte characters into a sequence of characters of type wchar_t.

Syntax

#include <stdlib.h>)

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

Arguments

pwcs The pwcs argument is a pointer to the resulting wide character string.

s The s argument is a pointer to the multibyte character sequence.

n The n argument is the maximum number of resulting wide characters stored in pwcs.

Description

The mbstowcs() function converts a sequence of multibyte characters from the array pointed to by s into a sequence of characters of type wchar_t, and stores not more than n characters into the array pointed to by pwcs. No multibyte characters that follow a null character (which is converted into a code with value zero) are examined or converted. No more than n elements are modified in the array pointed to by pwcs. This function is affected by the LC_CTYPE category of the current locale.

Return Values

If an invalid multibyte character is encountered, the mbstowcs() function returns (size_t) -1. Otherwise, the mbstowcs() function returns the number of array elements modified, not including a terminating null character, if any. The array will not be null-terminated if the value returned is n.

Museum