mbstowcs(3)

mbstowcs3

Convert a character string to a wide-character string

Usage

#include <stdlib.h>

size_t

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

#include <stdlib.h>

#include <xlocale.h>

size_t

mbstowcs_l(wchar_t *restrict pwcs, const char *restrict s, size_t n, locale_t loc);

Library

Standard C Library (libc, -lc)

Overview

The mbstowcs() function converts a multibyte character string s, beginning in the initial conversion state, into a wide character string pwcs. No more than n wide characters are stored. A terminating null wide character is appended, if there is room.

Although the mbstowcs() function uses the current locale, the mbstowcs_l() function may be passed a locale directly. See xlocale(3) for more information.

Return values

The mbstowcs() function returns the number of wide characters converted, not counting any terminating null wide character, or -1 if an invalid multibyte character was encountered.

Errors

The mbstowcs() function will fail if:

[EILSEQ]

An invalid multibyte sequence was detected.

[EINVAL]

The conversion state is invalid.

Releases

135 releases since Mac OS X 10.4; the text changed 2 times.

  1. 10.4–10.4.11
  2. 10.5–10.6.8
  3. 10.7–26.5

Standards

The mbstowcs() function conforms to ISO/IEC 9899:1999 (“ISO C99”).

From Libc 1752.120.2 in macOS 26.5. Parsed by carta from the page's mdoc source.