wcswidth(3) — Linux manual page

wcswidth(3)             Library Functions Manual             wcswidth(3)

NAME

       wcswidth - determine columns needed for a fixed-size wide-
       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 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

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌──────────────────────────────┬───────────────┬────────────────┐
       │ Interface                    │ Attribute     │ Value          │
       ├──────────────────────────────┼───────────────┼────────────────┤
       │ wcswidth()                   │ Thread safety │ MT-Safe locale │
       └──────────────────────────────┴───────────────┴────────────────┘

STANDARDS

       POSIX.1-2008.

HISTORY

       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 the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02                    wcswidth(3)

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

---