wcswidth(3) — Linux manual pages

Linux manual pages	Section 3

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.

COLOPHON

This page is part of release 3.72 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/.

  Copyright (c) Bruno Haible <haibleclisp.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 specification http://www.UNIX-systems.org/online.html