www.LinuxHowtos.org

wcwidth

Section: C Library Functions (3)
Updated: 202-0-08
Index Return to Main Contents

NAME

wcwidth - determine columns needed for a wide character

LIBRARY

Standard C library (libc,~-lc)

SYNOPSIS

#define _XOPEN_SOURCE       /* See feature_test_macros(7) */
#include <wchar.h>
int wcwidth(wchar_t wc);

DESCRIPTION

The wcwidth() function returns the number of columns needed to represent the wide character wc. If wc is a printable wide character, the value is at least 0. If wc is null wide character (L[aq][rs]0[aq]), the value is 0. Otherwise, -1 is returned.

RETURN VALUE

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

ATTRIBUTES

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

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

STANDARDS

POSIX.-2008.

HISTORY

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

int wcwidth(wint_t wc);

NOTES

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