lib/libc/string/wcswidth.3

   1 .\" $NetBSD: wcswidth.3,v 1.2 2006/10/16 08:48:45 wiz 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 .\" $DragonFly: src/lib/libc/string/wcswidth.3,v 1.1 2008/05/31 04:51:55 swildner Exp $
  29 .\"
  30 .Dd May 30, 2008
  31 .Dt WCSWIDTH 3
  32 .Os
  33 .Sh NAME
  34 .Nm wcswidth
  35 .Nd "number of column positions in wide-character string"
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In wchar.h
  40 .Ft int
  41 .Fn wcswidth "const wchar_t *pwcs" "size_t n"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn wcswidth
  45 function determines the number of column positions required for the first
  46 .Fa n
  47 characters of
  48 .Fa pwcs ,
  49 or until a nul wide character (L'\e0') is encountered.
  50 .Sh RETURN VALUES
  51 The
  52 .Fn wcswidth
  53 function returns 0 if
  54 .Fa pwcs
  55 is an empty string (L""),
  56 \-1 if a non-printing wide character is encountered,
  57 otherwise it returns the number of column positions occupied.
  58 .Sh SEE ALSO
  59 .Xr iswprint 3 ,
  60 .Xr wcwidth 3
  61 .Sh STANDARDS
  62 The
  63 .Fn wcswidth
  64 function conforms to
  65 .St -p1003.1-2001 .