wcswidth(3)

wcswidth3

Number of column positions in wide-character string

Usage

#include <wchar.h>

int

wcswidth(const wchar_t *pwcs, size_t n);

#include <wchar.h>

#include <xlocale.h>

int

wcswidth_l(const wchar_t *pwcs, size_t n, locale_t loc);

Library

Standard C Library (libc, -lc)

Overview

The wcswidth() function determines the number of column positions required for the first n characters of pwcs, or until a null wide character (L'\0') is encountered.

Although the wcswidth() function uses the current locale, the wcswidth_l() function may be passed a locale directly. See xlocale(3) for more information.

Return values

The wcswidth() function returns 0 if pwcs is an empty string (L""), -1 if a non-printing wide character is encountered; otherwise, it returns the number of column positions occupied.

Releases

145 releases since Mac OS X 10.3; the text changed 1 time.

  1. 10.3–10.4.11
  2. 10.5–26.5

Standards

The wcswidth() function conforms to IEEE Std 1003.1-2001 (“POSIX.1”).

From Libc 1752.120.2 in macOS 26.5. Parsed by carta from the page's mdoc source.