wcwidth (3)

Leading comments

Copyright (c) Bruno Haible <haible@clisp.cons.org>

%%%LICENSE_START(GPLv2+_DOC_ONEPARA)
This is free documentation; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
%%%LICENSE_END

References consulted:
  GNU glibc-2 source code and manual
  Dinkumware C library reference http://www.dinkumware.com/
  OpenGroup's Single UNIX specificat...

(The comments found at the beginning of the groff file "man3/wcwidth.3".)

NAME

wcwidth - determine columns needed for a wide character

SYNOPSIS

#define _XOPEN_SOURCE       /* See feature_test_macros(7) */
#include <wchar.h>

int wcwidth(wchar_t c);

DESCRIPTION

The wcwidth() function returns the number of columns needed to represent the wide character c. If c is a printable wide character, the value is at least 0. If c is null wide character (Laq\0aq), the value is 0. Otherwise, -1 is returned.

RETURN VALUE

The wcwidth() function returns the number of column positions for c.

ATTRIBUTES

For an explanation of the terms used in this section, see attributes(7).

Interface	Attribute	Value
wcwidth()	Thread safety	MT-Safe locale

CONFORMING TO

POSIX.1-2001, POSIX.1-2008.
Note that glibc before 2.2.5 used the prototype

int wcwidth(wint_t c);

NOTES

The behavior of wcwidth() depends on the LC_CTYPE category of the current locale.

SEE ALSO

iswprint(3), wcswidth(3)

COLOPHON

This page is part of release 4.04 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at www.kernel.org/doc/man-pages