summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2017/man3p/wcswidth.3p
diff options
context:
space:
mode:
Diffstat (limited to 'man-pages-posix-2017/man3p/wcswidth.3p')
-rw-r--r--man-pages-posix-2017/man3p/wcswidth.3p81
1 files changed, 81 insertions, 0 deletions
diff --git a/man-pages-posix-2017/man3p/wcswidth.3p b/man-pages-posix-2017/man3p/wcswidth.3p
new file mode 100644
index 0000000..d1ccdbe
--- /dev/null
+++ b/man-pages-posix-2017/man3p/wcswidth.3p
@@ -0,0 +1,81 @@
+'\" et
+.TH WCSWIDTH "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.SH 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.
+.\"
+.SH NAME
+wcswidth
+\(em number of column positions of a wide-character string
+.SH SYNOPSIS
+.LP
+.nf
+#include <wchar.h>
+.P
+int wcswidth(const wchar_t *\fIpwcs\fP, size_t \fIn\fP);
+.fi
+.SH DESCRIPTION
+The
+\fIwcswidth\fR()
+function shall determine the number of column positions required for
+.IR n
+wide-character codes (or fewer than
+.IR n
+wide-character codes if a null wide-character code is encountered
+before
+.IR n
+wide-character codes are exhausted) in the string pointed to by
+.IR pwcs .
+.SH "RETURN VALUE"
+The
+\fIwcswidth\fR()
+function either shall return 0 (if
+.IR pwcs
+points to a null wide-character code), or return the number of column
+positions to be occupied by the wide-character string pointed to by
+.IR pwcs ,
+or return \-1 (if any of the first
+.IR n
+wide-character codes in the wide-character string pointed to by
+.IR pwcs
+is not a printable wide-character code).
+.SH ERRORS
+No errors are defined.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "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.
+.SH RATIONALE
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIwcwidth\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "Section 3.103" ", " "Column Position",
+.IR "\fB<wchar.h>\fP"
+.\"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1-2017, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, 2018 Edition,
+Copyright (C) 2018 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+In the event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.opengroup.org/unix/online.html .
+.PP
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .