2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
|
|
|
.\"
|
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
|
.\"
|
|
|
|
|
.\" References consulted:
|
|
|
|
|
.\" GNU glibc-2 source code and manual
|
|
|
|
|
.\" Dinkumware C library reference http://www.dinkumware.com/
|
|
|
|
|
.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
|
|
|
|
|
.\"
|
2007-07-08 12:11:40 +00:00
|
|
|
.TH WCSWIDTH 3 2007-07-26 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
2007-04-24 19:40:35 +00:00
|
|
|
wcswidth \- determine columns needed for a fixed-size wide-character string
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
2007-07-08 12:11:40 +00:00
|
|
|
.B #define _XOPEN_SOURCE
|
2004-11-03 13:51:07 +00:00
|
|
|
.B #include <wchar.h>
|
|
|
|
|
.sp
|
|
|
|
|
.BI "int wcswidth(const wchar_t *" s ", size_t " n );
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR wcswidth ()
|
|
|
|
|
function returns the
|
2007-04-12 22:42:49 +00:00
|
|
|
number of columns needed to represent
|
2004-11-03 13:51:07 +00:00
|
|
|
the wide-character string pointed to by \fIs\fP, but at most \fIn\fP wide
|
2007-04-12 22:42:49 +00:00
|
|
|
characters.
|
|
|
|
|
If a non-printable wide character occurs among these characters,
|
2007-04-27 17:25:28 +00:00
|
|
|
\-1 is returned.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR wcswidth ()
|
|
|
|
|
function
|
2007-04-12 22:42:49 +00:00
|
|
|
returns the number of column positions for the
|
2004-11-03 13:51:07 +00:00
|
|
|
wide-character string \fIs\fP, truncated to at most length \fIn\fP.
|
|
|
|
|
.SH "CONFORMING TO"
|
2006-08-03 13:57:30 +00:00
|
|
|
POSIX.1-2001.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NOTES
|
2007-06-08 09:56:56 +00:00
|
|
|
The behavior of
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR wcswidth ()
|
2007-06-22 18:25:23 +00:00
|
|
|
depends on the
|
|
|
|
|
.B LC_CTYPE
|
|
|
|
|
category of the
|
2004-11-03 13:51:07 +00:00
|
|
|
current locale.
|
2007-05-16 18:25:50 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR iswprint (3),
|
|
|
|
|
.BR wcwidth (3)
|
