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: head/lib/libc/string/wcswidth.3 107706 2002-12-09 14:04:05Z ru $ 26.\" 27.Dd December 27, 2013 28.Dt WCSWIDTH 3 29.Os 30.Sh NAME 31.Nm wcswidth , 32.Nm wcswidth_l 33.Nd "number of column positions in wide-character string" 34.Sh LIBRARY 35.Lb libc 36.Sh SYNOPSIS 37.In wchar.h 38.Ft int 39.Fn wcswidth "const wchar_t *pwcs" "size_t n" 40.In xlocale.h 41.Ft int 42.Fn wcswidth_l "const wchar_t *pwcs" "size_t n" "locale_t locale" 43.Sh DESCRIPTION 44The 45.Fn wcswidth 46and 47.Fn wcswidth_l 48functions determine the number of column positions required for the first 49.Fa n 50characters of 51.Fa pwcs , 52or until a null wide character (L'\e0') is encountered. 53.Pp 54The 55.Fn wcswidth_l 56function takes an explicit 57.Fa locale 58argument, whereas the 59.Fn wcswidth 60function uses the current global or per-thread locale. 61.Sh RETURN VALUES 62The 63.Fn wcswidth 64and 65.Fn wcswidth_l 66functions return 0 if 67.Fa pwcs 68is an empty string (L""), 69\-1 if a non-printing wide character is encountered, 70otherwise they return the number of column positions occupied. 71.Sh SEE ALSO 72.Xr iswprint 3 , 73.Xr wcwidth 3 , 74.Xr xlocale 3 75.Sh STANDARDS 76The 77.Fn wcswidth 78function conforms to 79.St -p1003.1-2001 . 80