xref: /illumos-gate/usr/src/man/man3c/wcwidth.3c (revision 5ac95da7d61660aa299c287a39277cb0372be959)

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
http://www.opengroup.org/bookstore/.

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 SunOS 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.

This notice shall appear on any product containing this material.

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.

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.

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]


Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
Copyright 2014 Garrett D'Amore <garrett@damore.org>

WCWIDTH 3C "Jun 25, 2014"
NAME
wcwidth, wcwidth_l - number of column positions of a wide-character code
SYNOPSIS

#include <wchar.h>

int wcwidth(wchar_t wc);

#include <wchar.h>
#include <xlocale.h>

int wcwidth_l(wchar_t wc, locale_t loc);
DESCRIPTION

The wcwidth() function determines the number of column positions required for the wide character wc. The value of wc must be a character representable as a wchar_t, and must be a wide-character code corresponding to a valid character in the current locale.

The function wcwidth_l() behaves identically to wcwidth(), except instead of operating in the current locale, it operates in the locale specified by loc.

RETURN VALUES

These functions either return 0 (if wc is a null wide-character code), or the number of column positions to be occupied by the wide-character code wc, or -1 (if wc does not correspond to a printing wide-character code).

ERRORS

No errors are defined.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
CSI Enabled
Interface Stability See below.
MT-Level MT-Safe

The wcwidth() function is Standard. The wcwidth_l() function is Uncommitted.

SEE ALSO

newlocale(3C), setlocale(3C), uselocale(3C), wcswidth(3C), attributes(5), standards(5)