NAME

wcwidth − Determines the display width of wide characters

LIBRARY

Standard C Library (libc)

SYNOPSIS

#include <wchar.h>

int  wcwidth(
        wchar_t wc);

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

wcwidth(): XSH5.0

Refer to the standards(5) reference page for more information about industry standards and associated tags. 

PARAMETERS

wcSpecifies a wide character. 

DESCRIPTION

The wcwidth() function determines the number of display columns to be occupied by the wide character specified by the wc parameter. The behavior of the wcwidth() function is determined by the LC_CTYPE category. 

EXAMPLES

The following example finds the display width of a wide character:

#include <string.h>
#include <locale.h>
main()
{
wchar_t wc;
int   retval;
(void)setlocale(LC_ALL, "");
/∗ Let wc be the wide character whose
∗∗ display width is to be found.
∗/
retval= wcwidth( wc );
if(retval == -1){
/∗
∗∗ Error handling. Invalid wide character in wc.
∗/
}
}

RETURN VALUES

The wcwidth() function returns the number of display columns to be occupied by the wc parameter. If the wc parameter is a null wide character, a value of 0 (zero) is returned. If the wc parameter contains an invalid wide character code, a value of −1 is returned. 

RELATED INFORMATION

Functions: mblen(3), wcslen(3), wcswidth(3)

Standards: standards(5)