Content-type: text/html Man page of wcwidth

wcwidth

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

wcwidth - Determines the display width of wide characters  

LIBRARY

Standard C Library (libc.so, libc.a)  

SYNOPSIS

#include <wchar.h>

int wcwidth(
        wchar_t wc);  

STANDARDS

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

wcwidth(): XPG4

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

PARAMETERS

Specifies 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) delim off


 

Index

NAME
LIBRARY
SYNOPSIS
STANDARDS
PARAMETERS
DESCRIPTION
EXAMPLES
RETURN VALUES
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:42:39 GMT, October 02, 2010