logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

wcswidth.3p (2592B)

    

  1. '\" et
  2. .TH WCSWIDTH "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. wcswidth
  12. \(em number of column positions of a wide-character string
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <wchar.h>
  17. .P
  18. int wcswidth(const wchar_t *\fIpwcs\fP, size_t \fIn\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fIwcswidth\fR()
  23. function shall determine the number of column positions required for
  24. .IR n
  25. wide-character codes (or fewer than
  26. .IR n
  27. wide-character codes if a null wide-character code is encountered
  28. before
  29. .IR n
  30. wide-character codes are exhausted) in the string pointed to by
  31. .IR pwcs .
  32. .SH "RETURN VALUE"
  33. The
  34. \fIwcswidth\fR()
  35. function either shall return 0 (if
  36. .IR pwcs
  37. points to a null wide-character code), or return the number of column
  38. positions to be occupied by the wide-character string pointed to by
  39. .IR pwcs ,
  40. or return \-1 (if any of the first
  41. .IR n
  42. wide-character codes in the wide-character string pointed to by
  43. .IR pwcs
  44. is not a printable wide-character code).
  45. .SH ERRORS
  46. No errors are defined.
  47. .LP
  48. .IR "The following sections are informative."
  49. .SH EXAMPLES
  50. None.
  51. .SH "APPLICATION USAGE"
  52. This function was removed from the final ISO/IEC\ 9899:\|1990/Amendment 1:\|1995 (E), and the return value
  53. for a non-printable wide character is not specified.
  54. .SH RATIONALE
  55. None.
  56. .SH "FUTURE DIRECTIONS"
  57. None.
  58. .SH "SEE ALSO"
  59. .IR "\fIwcwidth\fR\^(\|)"
  60. .P
  61. The Base Definitions volume of POSIX.1\(hy2017,
  62. .IR "Section 3.103" ", " "Column Position",
  63. .IR "\fB<wchar.h>\fP"
  64. .\"
  65. .SH COPYRIGHT
  66. Portions of this text are reprinted and reproduced in electronic form
  67. from IEEE Std 1003.1-2017, Standard for Information Technology
  68. -- Portable Operating System Interface (POSIX), The Open Group Base
  69. Specifications Issue 7, 2018 Edition,
  70. Copyright (C) 2018 by the Institute of
  71. Electrical and Electronics Engineers, Inc and The Open Group.
  72. In the event of any discrepancy between this version and the original IEEE and
  73. The Open Group Standard, the original IEEE and The Open Group Standard
  74. is the referee document. The original Standard can be obtained online at
  75. http://www.opengroup.org/unix/online.html .
  76. .PP
  77. Any typographical or formatting errors that appear
  78. in this page are most likely
  79. to have been introduced during the conversion of the source files to
  80. man page format. To report such errors, see
  81. https://www.kernel.org/doc/man-pages/reporting_bugs.html .