locale/mbstowcs.3

   1 .\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
   2 .\" Copyright (c) 1993
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" Donn Seeley of BSDI.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\" From @(#)multibyte.3        8.1 (Berkeley) 6/4/93
  37 .\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
  38 .\" $FreeBSD: src/lib/libc/locale/mbstowcs.3,v 1.4 2004/07/05 06:36:36 ru Exp $
  39 .\"
  40 .Dd April 8, 2004
  41 .Dt MBSTOWCS 3
  42 .Os
  43 .Sh NAME
  44 .Nm mbstowcs ,
  45 .Nm mbstowcs_l
  46 .Nd convert a character string to a wide-character string
  47 .Sh LIBRARY
  48 .Lb libc
  49 .Sh SYNOPSIS
  50 .In stdlib.h
  51 .Ft size_t
  52 .Fo mbstowcs
  53 .Fa "wchar_t *restrict pwcs"
  54 .Fa "const char *restrict s"
  55 .Fa "size_t n"
  56 .Fc
  57 .In stdlib.h
  58 .In xlocale.h
  59 .Ft size_t
  60 .Fo mbstowcs_l
  61 .Fa "wchar_t *restrict pwcs"
  62 .Fa "const char *restrict s"
  63 .Fa "size_t n"
  64 .Fa "locale_t loc"
  65 .Fc
  66 .Sh DESCRIPTION
  67 The
  68 .Fn mbstowcs
  69 function converts a multibyte character string
  70 .Fa s ,
  71 beginning in the initial conversion state,
  72 into a wide character string
  73 .Fa pwcs .
  74 No more than
  75 .Fa n
  76 wide characters are stored.
  77 A terminating null wide character is appended, if there is room.
  78 .Pp
  79 Although the
  80 .Fn mbstowcs
  81 function uses the current locale, the
  82 .Fn mbstowcs_l
  83 function may be passed a locale directly. See
  84 .Xr xlocale 3
  85 for more information.
  86 .Sh RETURN VALUES
  87 The
  88 .Fn mbstowcs
  89 function returns the number of wide characters converted,
  90 not counting any terminating null wide character, or \-1
  91 if an invalid multibyte character was encountered.
  92 .Sh ERRORS
  93 The
  94 .Fn mbstowcs
  95 function will fail if:
  96 .Bl -tag -width Er
  97 .It Bq Er EILSEQ
  98 An invalid multibyte sequence was detected.
  99 .It Bq Er EINVAL
 100 The conversion state is invalid.
 101 .El
 102 .Sh SEE ALSO
 103 .Xr mbsrtowcs 3 ,
 104 .Xr mbtowc 3 ,
 105 .Xr multibyte 3 ,
 106 .Xr xlocale 3
 107 .Sh STANDARDS
 108 The
 109 .Fn mbstowcs
 110 function conforms to
 111 .St -isoC-99 .