lib/libc/string/wcswidth.3

   1 .\" $NetBSD: wcswidth.3,v 1.1 2006/06/03 04:36:45 tnozaki Exp $
   2 .\" FreeBSD: src/lib/libc/string/wcswidth.3,v 1.2 2002/12/09 14:04:05 ru Exp
   3 .\"
   4 .\" Copyright (c) 2002 Tim J. Robbins
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"
  29 .Dd August 20, 2002
  30 .Dt WCSWIDTH 3
  31 .Os
  32 .Sh NAME
  33 .Nm wcswidth
  34 .Nd "number of column positions in wide-character string"
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In wchar.h
  39 .Ft int
  40 .Fn wcswidth "const wchar_t *pwcs" "size_t n"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn wcswidth
  44 function determines the number of column positions required for the first
  45 .Fa n
  46 characters of
  47 .Fa pwcs ,
  48 or until a nul wide character (L'\e0') is encountered.
  49 .Sh RETURN VALUES
  50 The
  51 .Fn wcswidth
  52 function returns 0 if
  53 .Fa pwcs
  54 is an empty string (L""),
  55 \-1 if a non-printing wide character is encountered,
  56 otherwise it returns the number of column positions occupied.
  57 .Sh SEE ALSO
  58 .Xr iswprint 3 ,
  59 .Xr wcwidth 3
  60 .Sh STANDARDS
  61 The
  62 .Fn wcswidth
  63 function conforms to
  64 .St -p1003.1-2001 .