You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

121 lines
5.4KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  6. <title>wcsftime (The Red Hat newlib C Library)</title>
  7. <meta name="description" content="wcsftime (The Red Hat newlib C Library)">
  8. <meta name="keywords" content="wcsftime (The Red Hat newlib C Library)">
  9. <meta name="resource-type" content="document">
  10. <meta name="distribution" content="global">
  11. <meta name="Generator" content="makeinfo">
  12. <link href="index.html#Top" rel="start" title="Top">
  13. <link href="Document-Index.html#Document-Index" rel="index" title="Document Index">
  14. <link href="Document-Index.html#SEC_Contents" rel="contents" title="Table of Contents">
  15. <link href="Wchar-strings.html#Wchar-strings" rel="up" title="Wchar strings">
  16. <link href="wcslcat.html#wcslcat" rel="next" title="wcslcat">
  17. <link href="wcscspn.html#wcscspn" rel="prev" title="wcscspn">
  18. <style type="text/css">
  19. <!--
  20. a.summary-letter {text-decoration: none}
  21. blockquote.indentedblock {margin-right: 0em}
  22. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  23. blockquote.smallquotation {font-size: smaller}
  24. div.display {margin-left: 3.2em}
  25. div.example {margin-left: 3.2em}
  26. div.lisp {margin-left: 3.2em}
  27. div.smalldisplay {margin-left: 3.2em}
  28. div.smallexample {margin-left: 3.2em}
  29. div.smalllisp {margin-left: 3.2em}
  30. kbd {font-style: oblique}
  31. pre.display {font-family: inherit}
  32. pre.format {font-family: inherit}
  33. pre.menu-comment {font-family: serif}
  34. pre.menu-preformatted {font-family: serif}
  35. pre.smalldisplay {font-family: inherit; font-size: smaller}
  36. pre.smallexample {font-size: smaller}
  37. pre.smallformat {font-family: inherit; font-size: smaller}
  38. pre.smalllisp {font-size: smaller}
  39. span.nolinebreak {white-space: nowrap}
  40. span.roman {font-family: initial; font-weight: normal}
  41. span.sansserif {font-family: sans-serif; font-weight: normal}
  42. ul.no-bullet {list-style: none}
  43. -->
  44. </style>
  45. </head>
  46. <body lang="en">
  47. <a name="wcsftime"></a>
  48. <div class="header">
  49. <p>
  50. Next: <a href="wcslcat.html#wcslcat" accesskey="n" rel="next">wcslcat</a>, Previous: <a href="wcscspn.html#wcscspn" accesskey="p" rel="prev">wcscspn</a>, Up: <a href="Wchar-strings.html#Wchar-strings" accesskey="u" rel="up">Wchar strings</a> &nbsp; [<a href="Document-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Document-Index.html#Document-Index" title="Index" rel="index">Index</a>]</p>
  51. </div>
  52. <hr>
  53. <a name="wcsftime_002d_002d_002dconvert-date-and-time-to-a-formatted-wide_002dcharacter-string"></a>
  54. <h3 class="section">6.14 <code>wcsftime</code>&mdash;convert date and time to a formatted wide-character string</h3>
  55. <a name="index-wcsftime"></a>
  56. <p><strong>Synopsis</strong>
  57. </p><div class="example">
  58. <pre class="example">#include &lt;time.h&gt;
  59. #include &lt;wchar.h&gt;
  60. size_t wcsftime(wchar_t *<var>s</var>, size_t <var>maxsize</var>,
  61. const wchar_t *<var>format</var>, const struct tm *<var>timp</var>);
  62. </pre></div>
  63. <p><strong>Description</strong><br>
  64. <code>wcsftime</code> is equivalent to <code>strftime</code>, except that:
  65. </p><ul>
  66. <li> The argument s points to the initial element of an array of wide characters
  67. into which the generated output is to be placed.
  68. </li><li> The argument maxsize indicates the limiting number of wide characters.
  69. </li><li> The argument format is a wide-character string and the conversion specifiers
  70. are replaced by corresponding sequences of wide characters.
  71. </li><li> The return value indicates the number of wide characters.
  72. </li></ul>
  73. <p>(The difference in all of the above being wide characters versus regular
  74. characters.)
  75. See <code>strftime</code> for the details of the format specifiers.
  76. </p>
  77. <br>
  78. <p><strong>Returns</strong><br>
  79. When the formatted time takes up no more than <var>maxsize</var> wide characters,
  80. the result is the length of the formatted wide string. Otherwise, if the
  81. formatting operation was abandoned due to lack of room, the result is
  82. <code>0</code>, and the wide-character string starting at <var>s</var> corresponds to just those
  83. parts of <code>*<var>format</var></code> that could be completely filled in within the
  84. <var>maxsize</var> limit.
  85. </p>
  86. <br>
  87. <p><strong>Portability</strong><br>
  88. C99 and POSIX require <code>wcsftime</code>, but do not specify the contents of
  89. <code>*<var>s</var></code> when the formatted string would require more than
  90. <var>maxsize</var> characters. Unrecognized specifiers and fields of
  91. <code>timp</code> that are out of range cause undefined results. Since some
  92. formats expand to 0 bytes, it is wise to set <code>*<var>s</var></code> to a nonzero
  93. value beforehand to distinguish between failure and an empty string.
  94. This implementation does not support <code>s</code> being NULL, nor overlapping
  95. <code>s</code> and <code>format</code>.
  96. </p>
  97. <p><code>wcsftime</code> requires no supporting OS subroutines.
  98. </p>
  99. <br>
  100. <p><strong>See Also</strong><br>
  101. <code>strftime</code>
  102. </p>
  103. <br>
  104. <hr>
  105. <div class="header">
  106. <p>
  107. Next: <a href="wcslcat.html#wcslcat" accesskey="n" rel="next">wcslcat</a>, Previous: <a href="wcscspn.html#wcscspn" accesskey="p" rel="prev">wcscspn</a>, Up: <a href="Wchar-strings.html#Wchar-strings" accesskey="u" rel="up">Wchar strings</a> &nbsp; [<a href="Document-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Document-Index.html#Document-Index" title="Index" rel="index">Index</a>]</p>
  108. </div>
  109. </body>
  110. </html>