wcswidth(3) — Linux manual page

wcswidth(3)             Library Functions Manual             wcswidth(3)

NAME         top

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

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

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

       int wcswidth(const wchar_t *s, size_t n);

DESCRIPTION         top

       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         top

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

ATTRIBUTES         top

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

       ┌───────────────────────────────┬───────────────┬────────────────┐
       │Interface                      │ Attribute     │ Value          │
       ├───────────────────────────────┼───────────────┼────────────────┤
       │wcswidth()                     │ Thread safety │ MT-Safe locale │
       └───────────────────────────────┴───────────────┴────────────────┘

STANDARDS         top

       POSIX.1-2008.

HISTORY         top

       POSIX.1-2001.

NOTES         top

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

SEE ALSO         top

       iswprint(3), wcwidth(3)

Linux man-pages 6.04           2023-03-30                    wcswidth(3)

Pages that refer to this page: wcwidth(3),  utf-8(7)

HTML rendering created 2023-06-24 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.