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

wcsftime.3p (3412B)

    

  1. '\" et
  2. .TH WCSFTIME "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. wcsftime
  12. \(em convert date and time to a wide-character string
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <wchar.h>
  17. .P
  18. size_t wcsftime(wchar_t *restrict \fIwcs\fP, size_t \fImaxsize\fP,
  19.     const wchar_t *restrict \fIformat\fP, const struct tm *restrict \fItimeptr\fP);
  20. .fi
  21. .SH DESCRIPTION
  22. The functionality described on this reference page is aligned with the
  23. ISO\ C standard. Any conflict between the requirements described here and the
  24. ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
  25. .P
  26. The
  27. \fIwcsftime\fR()
  28. function shall be equivalent to the
  29. \fIstrftime\fR()
  30. function, except that:
  31. .IP " *" 4
  32. The argument
  33. .IR wcs
  34. points to the initial element of an array of wide characters into which
  35. the generated output is to be placed.
  36. .IP " *" 4
  37. The argument
  38. .IR maxsize
  39. indicates the maximum number of wide characters to be placed in the
  40. output array.
  41. .IP " *" 4
  42. The argument
  43. .IR format
  44. is a wide-character string and the conversion specifications are
  45. replaced by corresponding sequences of wide characters.
  46. It is unspecified whether an encoding error occurs if the format
  47. string contains
  48. .BR wchar_t
  49. values that do not correspond to members of the character set of the
  50. current locale.
  51. .IP " *" 4
  52. Field widths specify the number of wide characters instead of the
  53. number of bytes.
  54. .IP " *" 4
  55. The return value indicates the number of wide characters placed in the
  56. output array.
  57. .P
  58. If copying takes place between objects that overlap, the behavior is
  59. undefined.
  60. .SH "RETURN VALUE"
  61. If the total number of resulting wide-character codes including the
  62. terminating null wide-character code is no more than
  63. .IR maxsize ,
  64. \fIwcsftime\fR()
  65. shall return the number of wide-character codes placed into the array
  66. pointed to by
  67. .IR wcs ,
  68. not including the terminating null wide-character code. Otherwise,
  69. zero is returned and the contents of the array are unspecified.
  70. .SH ERRORS
  71. No errors are defined.
  72. .LP
  73. .IR "The following sections are informative."
  74. .SH EXAMPLES
  75. None.
  76. .SH "APPLICATION USAGE"
  77. None.
  78. .SH RATIONALE
  79. None.
  80. .SH "FUTURE DIRECTIONS"
  81. None.
  82. .SH "SEE ALSO"
  83. .IR "\fIstrftime\fR\^(\|)"
  84. .P
  85. The Base Definitions volume of POSIX.1\(hy2017,
  86. .IR "\fB<wchar.h>\fP"
  87. .\"
  88. .SH COPYRIGHT
  89. Portions of this text are reprinted and reproduced in electronic form
  90. from IEEE Std 1003.1-2017, Standard for Information Technology
  91. -- Portable Operating System Interface (POSIX), The Open Group Base
  92. Specifications Issue 7, 2018 Edition,
  93. Copyright (C) 2018 by the Institute of
  94. Electrical and Electronics Engineers, Inc and The Open Group.
  95. In the event of any discrepancy between this version and the original IEEE and
  96. The Open Group Standard, the original IEEE and The Open Group Standard
  97. is the referee document. The original Standard can be obtained online at
  98. http://www.opengroup.org/unix/online.html .
  99. .PP
  100. Any typographical or formatting errors that appear
  101. in this page are most likely
  102. to have been introduced during the conversion of the source files to
  103. man page format. To report such errors, see
  104. https://www.kernel.org/doc/man-pages/reporting_bugs.html .