[Go to CFHT Home Page] Man Pages
Back to Software Index  BORDER=0Manpage Top Level
    WCSWIDTH(3) manual page Table of Contents

Name

wcswidth - determine columns needed for a fixed-size wide-character string

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 wide-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 wide-character string s, truncated to at most length n.

Attributes

Multithreading (see pthreads(7) )

The wcswidth() function is thread-safe with exceptions. It can be safely used in multithreaded applications, as long as setlocale(3) is not called to change the locale during its execution.

Conforming to

POSIX.1-2001.

Notes

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

See Also

iswprint(3) , wcwidth(3)

Colophon

This page is part of release 3.78 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 http://www.kernel.org/doc/man-pages/.

Table of Contents