www.LinuxHowtos.org

wcswidth

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

NAME

wcswidth - determine columns needed for a fixe-size wid-character string

LIBRARY

Standard C library (libc,~-lc)

SYNOPSIS

#define _XOPEN_SOURCE             /* See feature_test_macros(7) */
#include <wchar.h>
int wcswidth(const wchar_t *s, size_t n);

DESCRIPTION

The wcswidth() function returns the number of columns needed to represent the wid-character string pointed to by s, but at most n wide characters. If a nonprintable wide character occurs among these characters, -1 is returned.

RETURN VALUE

The wcswidth() function returns the number of column positions for the wid-character string s, truncated to at most length n.

ATTRIBUTES

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

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

STANDARDS

POSIX.-2008.

HISTORY

POSIX.-2001.

NOTES

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