wcswidth(3c) [opensolaris man page]
wcswidth(3C) Standard C Library Functions wcswidth(3C) NAME
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 determines 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 VALUES
The wcswidth() function either returns 0 (if pwcs points to a null wide-character code), or returns the number of column positions to be occupied by the wide-character string pointed to by pwcs, or returns -1 (if any of the first n wide-character codes in the wide-character string pointed to by pwcs is not a printing wide-character code). ERRORS
No errors are defined. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |CSI |Enabled | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe with exceptions | +-----------------------------+-----------------------------+ SEE ALSO
setlocale(3C), wcwidth(3C), attributes(5), standards(5) SunOS 5.11 14 Aug 2002 wcswidth(3C)
Check Out this Related Man Page
wcswidth(3) Library Functions Manual wcswidth(3) NAME
wcswidth - Determines the display width of wide-character strings LIBRARY
Standard C Library (libc) SYNOPSIS
#include <wchar.h> int wcswidth( const wchar_t *pwcs, size_t n); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: wcswidth(): XSH5.0 Refer to the standards(5) reference page for more information about industry standards and associated tags. PARAMETERS
Contains a pointer to the wide-character string. Specifies the maximum number of wide characters whose display width is to be determined. DESCRIPTION
The wcswidth() function determines the number of display columns to be occupied by the number of wide characters specified by the n parame- ter in the string pointed to by the pwcs parameter. The behavior of the wcswidth() function is affected by the LC_CTYPE category. Fewer than the number of wide characters specified by the n parameter are counted if a null wide character is encountered first. EXAMPLES
The following example finds the display column width of a wide-character string: #include <wchar.h> #include <locale.h> main() { wchar_t *pwcs; int retval, n ; (void)setlocale(LC_ALL, ""); /* Let pwcs point to a wide-character null-terminated ** string. Let n be the number of wide characters whose ** display column width is to be determined. */ retval= wcswidth( pwcs, n ); if(retval == -1){ /* Error handling. Invalid wide-character code ** encountered in the wide-character string pwcs. */ } } RETURN VALUES
The wcswidth() function returns the number of display columns to be occupied by the specified number of wide characters or (if a null wide character is encountered first) by the number of wide characters encountered before the null. The function returns a value of 0 (zero) if the pwcs parameter is a null pointer or a pointer to a null pointer (that is, if either pwcs or *pwcs is null. The function returns -1 if the pwcs parameter points to a nonprinting wide character. RELATED INFORMATION
Functions: mblen(3), wcslen(3), wcwidth(3) Standards: standards(5) delim off wcswidth(3)