mbstowcs — convert a multibyte string to a wide-character string
#include <stdlib.h>
size_t
mbstowcs( |
wchar_t *dest, |
const char *src, | |
size_t n) ; |
If dest
is not
NULL, the mbstowcs
() function
converts the multibyte string src
to a wide-character string
starting at dest
. At
most n
wide
characters are written to dest
. The conversion starts in
the initial state. The conversion can stop for three
reasons:
An invalid multibyte sequence has been encountered. In this case, (size_t) −1 is returned.
n
non-L'\0'
wide characters have been stored at dest
. In this case, the
number of wide characters written to dest
is returned, but the
shift state at this point is lost.
The multibyte string has been completely converted,
including the terminating null wide character ('\0').
In this case, the number of wide characters written to
dest
, excluding
the terminating null wide character, is returned.
The programmer must ensure that there is room for at least
n
wide characters at
dest
.
If dest
is NULL,
n
is ignored, and the
conversion proceeds as above, except that the converted wide
characters are not written out to memory, and that no length
limit exists.
In order to avoid the case 2 above, the programmer should
make sure n
is
greater than or equal to mbstowcs(NULL,src,0)+1
.
The mbstowcs
() function
returns the number of wide characters that make up the
converted part of the wide-character string, not including
the terminating null wide character. If an invalid multibyte
sequence was encountered, (size_t)
−1 is returned.
For an explanation of the terms used in this section, see attributes(7).
Interface | Attribute | Value |
mbstowcs () |
Thread safety | MT-Safe |
The behavior of mbstowcs
()
depends on the LC_CTYPE
category of the current locale.
The function mbsrtowcs(3) provides a better interface to the same functionality.
The program below illustrates the use of mbstowcs
(), as well as some of the wide
character classification functions. An example run is the
following:
$ ./t_mbstowcs de_DE.UTF−8 Grüße! Length of source string (excluding terminator): 8 bytes 6 multibyte characters Wide character string is: Grüße! (6 characters) G alpha upper r alpha lower ü alpha lower ß alpha lower e alpha lower ! !alpha
#include <locale.h> #include <wchar.h> #include <stdio.h> #include <string.h> #include <stdlib.h> int main(int argc, char *argv[]) { size_t mbslen; /* Number of multibyte characters in source */ wchar_t *wcs; /* Pointer to converted wide character string */ wchar_t *wp; if (argc < 3) { fprintf(stderr, "Usage: %s <locale> <string>\n", argv[0]); exit(EXIT_FAILURE); } /* Apply the specified locale */ if (setlocale(LC_ALL, argv[1]) == NULL) { perror("setlocale"); exit(EXIT_FAILURE); } /* Calculate the length required to hold argv[2] converted to a wide character string */ mbslen = mbstowcs(NULL, argv[2], 0); if (mbslen == (size_t) −1) { perror("mbstowcs"); exit(EXIT_FAILURE); } /* Describe the source string to the user */ printf("Length of source string (excluding terminator):\n"); printf(" %zu bytes\n", strlen(argv[2])); printf(" %zu multibyte characters\n\n", mbslen); /* Allocate wide character string of the desired size. Add 1 to allow for terminating null wide character (L'\0'). */ wcs = calloc(mbslen + 1, sizeof(wchar_t)); if (wcs == NULL) { perror("calloc"); exit(EXIT_FAILURE); } /* Convert the multibyte character string in argv[2] to a wide character string */ if (mbstowcs(wcs, argv[2], mbslen + 1) == (size_t) −1) { perror("mbstowcs"); exit(EXIT_FAILURE); } printf("Wide character string is: %ls (%zu characters)\n", wcs, mbslen); /* Now do some inspection of the classes of the characters in the wide character string */ for (wp = wcs; *wp != 0; wp++) { printf(" %lc ", (wint_t) *wp); if (!iswalpha(*wp)) printf("!"); printf("alpha "); if (iswalpha(*wp)) { if (iswupper(*wp)) printf("upper "); if (iswlower(*wp)) printf("lower "); } putchar('\n'); } exit(EXIT_SUCCESS); }
This page is part of release 4.07 of the Linux man-pages
project. A
description of the project, information about reporting bugs,
and the latest version of this page, can be found at
https://www.kernel.org/doc/man−pages/.
t -*- coding: UTF-8 -*- Copyright (c) Bruno Haible <haibleclisp.cons.org> and Copyright 2014 Michael Kerrisk <mtk.manpagesgmail.com> %%%LICENSE_START(GPLv2+_DOC_ONEPARA) This is free documentation; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. %%%LICENSE_END References consulted: GNU glibc-2 source code and manual Dinkumware C library reference http://www.dinkumware.com/ OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html ISO/IEC 9899:1999 |