locale/FreeBSD/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 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" From @(#)multibyte.3        8.1 (Berkeley) 6/4/93
  33 .\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
  34 .\" $FreeBSD: src/lib/libc/locale/mbstowcs.3,v 1.5 2007/01/09 00:28:00 imp Exp $
  35 .\"
  36 .Dd April 8, 2004
  37 .Dt MBSTOWCS 3
  38 .Os
  39 .Sh NAME
  40 .Nm mbstowcs ,
  41 .Nm mbstowcs_l
  42 .Nd convert a character string to a wide-character string
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In stdlib.h
  47 .Ft size_t
  48 .Fo mbstowcs
  49 .Fa "wchar_t *restrict pwcs"
  50 .Fa "const char *restrict s"
  51 .Fa "size_t n"
  52 .Fc
  53 .In stdlib.h
  54 .In xlocale.h
  55 .Ft size_t
  56 .Fo mbstowcs_l
  57 .Fa "wchar_t *restrict pwcs"
  58 .Fa "const char *restrict s"
  59 .Fa "size_t n"
  60 .Fa "locale_t loc"
  61 .Fc
  62 .Sh DESCRIPTION
  63 The
  64 .Fn mbstowcs
  65 function converts a multibyte character string
  66 .Fa s ,
  67 beginning in the initial conversion state,
  68 into a wide character string
  69 .Fa pwcs .
  70 No more than
  71 .Fa n
  72 wide characters are stored.
  73 A terminating null wide character is appended, if there is room.
  74 .Pp
  75 Although the
  76 .Fn mbstowcs
  77 function uses the current locale, the
  78 .Fn mbstowcs_l
  79 function may be passed a locale directly. See
  80 .Xr xlocale 3
  81 for more information.
  82 .Sh RETURN VALUES
  83 The
  84 .Fn mbstowcs
  85 function returns the number of wide characters converted,
  86 not counting any terminating null wide character, or \-1
  87 if an invalid multibyte character was encountered.
  88 .Sh ERRORS
  89 The
  90 .Fn mbstowcs
  91 function will fail if:
  92 .Bl -tag -width Er
  93 .It Bq Er EILSEQ
  94 An invalid multibyte sequence was detected.
  95 .It Bq Er EINVAL
  96 The conversion state is invalid.
  97 .El
  98 .Sh SEE ALSO
  99 .Xr mbsrtowcs 3 ,
 100 .Xr mbtowc 3 ,
 101 .Xr multibyte 3 ,
 102 .Xr xlocale 3
 103 .Sh STANDARDS
 104 The
 105 .Fn mbstowcs
 106 function conforms to
 107 .St -isoC-99 .