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