wcwidth - Man Page

number of column positions of a wide-character code

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.

Synopsis

#include <wchar.h>

int wcwidth(wchar_t wc);

Description

The wcwidth() function shall determine the number of column positions required for the wide character wc. The application shall ensure that the value of wc is a character representable as a wchar_t, and is a wide-character code corresponding to a valid character in the current locale.

Return Value

The wcwidth() function shall either return 0 (if wc is a null wide-character code), or return the number of column positions to be occupied by the wide-character code wc, or return -1 (if wc does not correspond to a printable wide-character code).

Errors

No errors are defined.

The following sections are informative.

Examples

None.

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.

Rationale

None.

Future Directions

None.

See Also

wcswidth()

The Base Definitions volume of POSIX.1-2017, <wchar.h>

Referenced By

wchar.h(0p), wcswidth(3p).

2017 IEEE/The Open Group POSIX Programmer's Manual