wcswidth man page

Prolog

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

wcswidth — number of column positions of a wide-character string

Synopsis

#include <wchar.h>

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

Description

The wcswidth() function shall determine the number of column positions required for n wide-character codes (or fewer than n wide-character codes if a null wide-character code is encountered before n wide-character codes are exhausted) in the string pointed to by pwcs.

Return Value

The wcswidth() function either shall return 0 (if pwcs points to a null wide-character code), or return the number of column positions to be occupied by the wide-character string pointed to by pwcs, or return -1 (if any of the first n wide-character codes in the wide-character string pointed to by pwcs is not a printable wide-character code).

Errors

No errors are defined.

The following sections are informative.

Application Usage

This function was removed from the final ISO/IEC 9899:1990/Amendment 1:1995 (E), and the return value for a non-printable wide character is not specified.

See Also

wcwidth()

The Base Definitions volume of POSIX.1‐2008, Section 3.103, Column Position, <wchar.h>

Info

2013 IEEE/The Open Group POSIX Programmer's Manual