1 '\" te 2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org> 3 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. 4 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved 5 .\" 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 6 .\" http://www.opengroup.org/bookstore/. 7 .\" 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. 8 .\" This notice shall appear on any product containing this material. 9 .\" 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. 10 .\" 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. 11 .\" 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] 12 .TH WCSWIDTH 3C "Jul 11, 2014" 13 .SH NAME 14 wcswidth, wcswidth_l \- number of column positions of a wide-character string 15 .SH SYNOPSIS 16 .LP 17 .nf 18 #include <wchar.h> 19 20 \fBint\fR \fBwcswidth\fR(\fBconst wchar_t *\fR\fIpwcs\fR, \fBsize_t\fR \fIn\fR); 21 .fi 22 .LP 23 .nf 24 #include <wchar.h> 25 #include <xlocale.h> 26 27 \fBint\fR \fBwcswidth_l\fR(\fBconst wchar_t *\fR\fIpwcs\fR, \fBsize_t\fR \fIn\fR, \fBlocale_t\fR \fIloc\fR); 28 .fi 29 30 .SH DESCRIPTION 31 .sp 32 .LP 33 The \fBwcswidth()\fR function determines the number of column positions 34 required for \fIn\fR wide-character codes (or fewer than \fIn\fR wide-character 35 codes if a null wide-character code is encountered before \fIn\fR 36 wide-character codes are exhausted) in the string pointed to by \fIpwcs\fR. 37 .SH RETURN VALUES 38 .LP 39 The \fBwcswidth()\fR function either returns \fB0\fR (if \fIpwcs\fR points to a 40 null wide-character code), or returns the number of column positions to be 41 occupied by the wide-character string pointed to by \fIpwcs\fR, or returns 42 \fB\(mi1\fR (if any of the first \fIn\fR wide-character codes in the 43 wide-character string pointed to by \fIpwcs\fR is not a printing wide-character 44 code). 45 .LP 46 The function \fBwcwidth_l()\fR behaves identically to \fBwcwidth()\fR, except 47 instead of operating in the current environemtn, it operates in the environment 48 specified by \fIloc\fR. 49 .SH ERRORS 50 .LP 51 No errors are defined. 52 .SH ATTRIBUTES 53 .LP 54 See \fBattributes\fR(5) for descriptions of the following attributes: 55 .TS 56 box; 57 c | c 58 l | l . 59 ATTRIBUTE TYPE ATTRIBUTE VALUE 60 _ 61 CSI Enabled 62 _ 63 Interface Stability Standard 64 _ 65 MT-Level MT-Safe with exceptions 66 .TE 67 68 .SH SEE ALSO 69 .LP 70 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C), 71 \fBwcwidth\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)