Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/wcsftime.html
2024-02-19 00:21:47 -05:00

157 lines
5.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>wcsftime</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="wcsftime"></a> <a name="tag_03_832"></a><!-- wcsftime -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_832_01"></a>NAME</h4>
<blockquote>wcsftime - convert date and time to a wide-character string</blockquote>
<h4><a name="tag_03_832_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<p><code><tt>#include &lt;<a href="../basedefs/wchar.h.html">wchar.h</a>&gt;<br>
<br>
size_t wcsftime(wchar_t *restrict</tt> <i>wcs</i><tt>, size_t</tt> <i>maxsize</i><tt>,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; const wchar_t *restrict</tt> <i>format</i><tt>, const struct tm *restrict</tt>
<i>timeptr</i><tt>);<br>
</tt></code></p>
</blockquote>
<h4><a name="tag_03_832_03"></a>DESCRIPTION</h4>
<blockquote>
<div class="box"><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]"
border="0"> The functionality described on this reference page is aligned with the ISO&nbsp;C standard. Any conflict between the
requirements described here and the ISO&nbsp;C standard is unintentional. This volume of IEEE&nbsp;Std&nbsp;1003.1-2001 defers to
the ISO&nbsp;C standard. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></div>
<p>The <i>wcsftime</i>() function shall be equivalent to the <a href="../functions/strftime.html"><i>strftime</i>()</a> function,
except that:</p>
<ul>
<li>
<p>The argument <i>wcs</i> points to the initial element of an array of wide characters into which the generated output is to be
placed.</p>
</li>
<li>
<p>The argument <i>maxsize</i> indicates the maximum number of wide characters to be placed in the output array.</p>
</li>
<li>
<p>The argument <i>format</i> is a wide-character string and the conversion specifications are replaced by corresponding sequences
of wide characters.</p>
</li>
<li>
<p>The return value indicates the number of wide characters placed in the output array.</p>
</li>
</ul>
<p>If copying takes place between objects that overlap, the behavior is undefined.</p>
</blockquote>
<h4><a name="tag_03_832_04"></a>RETURN VALUE</h4>
<blockquote>
<p>If the total number of resulting wide-character codes including the terminating null wide-character code is no more than
<i>maxsize</i>, <i>wcsftime</i>() shall return the number of wide-character codes placed into the array pointed to by <i>wcs</i>,
not including the terminating null wide-character code. Otherwise, zero is returned and the contents of the array are
unspecified.</p>
</blockquote>
<h4><a name="tag_03_832_05"></a>ERRORS</h4>
<blockquote>
<p>No errors are defined.</p>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_832_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_832_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_832_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_832_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_832_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="strftime.html"><i>strftime</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/wchar.h.html"><i>&lt;wchar.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_832_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 4.</p>
</blockquote>
<h4><a name="tag_03_832_12"></a>Issue 5</h4>
<blockquote>
<p>Moved from ENHANCED I18N to BASE and the [ENOSYS] error is removed.</p>
<p>Aligned with ISO/IEC&nbsp;9899:1990/Amendment 1:1995 (E). Specifically, the type of the <i>format</i> argument is changed from
<b>const char *</b> to <b>const wchar_t *</b>.</p>
</blockquote>
<h4><a name="tag_03_832_13"></a>Issue 6</h4>
<blockquote>
<p>The <i>wcsftime</i>() prototype is updated for alignment with the ISO/IEC&nbsp;9899:1999 standard.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>