1 '\" te
   2 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   3 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH WCSWIDTH 3C "Aug 14, 2002"
  12 .SH NAME
  13 wcswidth \- number of column positions of a wide-character string
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <wchar.h>
  18 
  19 \fBint\fR \fBwcswidth\fR(\fBconst wchar_t *\fR\fIpwcs\fR, \fBsize_t\fR \fIn\fR);
  20 .fi
  21 
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBwcswidth()\fR function determines the number of column positions
  26 required for \fIn\fR wide-character codes (or fewer than \fIn\fR wide-character
  27 codes if a null wide-character code is encountered before \fIn\fR
  28 wide-character codes are exhausted) in the string pointed to by \fIpwcs\fR.
  29 .SH RETURN VALUES
  30 .sp
  31 .LP
  32 The \fBwcswidth()\fR function either returns \fB0\fR (if \fIpwcs\fR points to a
  33 null wide-character code), or returns the number of column positions to be
  34 occupied by the wide-character string pointed to by \fIpwcs\fR, or returns
  35 \fB\(mi1\fR (if any of the first \fIn\fR wide-character codes in the
  36 wide-character string pointed to by \fIpwcs\fR is not a printing wide-character
  37 code).
  38 .SH ERRORS
  39 .sp
  40 .LP
  41 No errors are defined.
  42 .SH ATTRIBUTES
  43 .sp
  44 .LP
  45 See \fBattributes\fR(5) for descriptions of the following attributes:
  46 .sp
  47 
  48 .sp
  49 .TS
  50 box;
  51 c | c
  52 l | l .
  53 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  54 _
  55 CSI     Enabled
  56 _
  57 Interface Stability     Standard
  58 _
  59 MT-Level        MT-Safe with exceptions
  60 .TE
  61 
  62 .SH SEE ALSO
  63 .sp
  64 .LP
  65 \fBsetlocale\fR(3C), \fBwcwidth\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)