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

187 lines
6.4 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>utimes</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="utimes"></a> <a name="tag_03_807"></a><!-- utimes -->
<!--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_807_01"></a>NAME</h4>
<blockquote>utimes - set file access and modification times (<b>LEGACY</b>)</blockquote>
<h4><a name="tag_03_807_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/sys/time.h.html">sys/time.h</a>&gt;<br>
<br>
int utimes(const char *</tt><i>path</i><tt>, const struct timeval</tt> <i>times[2]</i><tt>); <img src="../images/opt-end.gif" alt=
"[Option End]" border="0"></tt></code></div>
<tt><br>
</tt></blockquote>
<h4><a name="tag_03_807_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>utimes</i>() function shall set the access and modification times of the file pointed to by the <i>path</i> argument to
the value of the <i>times</i> argument. The <i>utimes</i>() function allows time specifications accurate to the microsecond.</p>
<p>For <i>utimes</i>(), the <i>times</i> argument is an array of <b>timeval</b> structures. The first array member represents the
date and time of last access, and the second member represents the date and time of last modification. The times in the
<b>timeval</b> structure are measured in seconds and microseconds since the Epoch, although rounding toward the nearest second may
occur.</p>
<p>If the <i>times</i> argument is a null pointer, the access and modification times of the file shall be set to the current time.
The effective user ID of the process shall match the owner of the file, or has write access to the file or appropriate privileges
to use this call in this manner. Upon completion, <i>utimes</i>() shall mark the time of the last file status change,
<i>st_ctime</i>, for update.</p>
</blockquote>
<h4><a name="tag_03_807_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Upon successful completion, 0 shall be returned. Otherwise, -1 shall be returned and <i>errno</i> shall be set to indicate the
error, and the file times shall not be affected.</p>
</blockquote>
<h4><a name="tag_03_807_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>utimes</i>() function shall fail if:</p>
<dl compact>
<dt>[EACCES]</dt>
<dd>Search permission is denied by a component of the path prefix; or the <i>times</i> argument is a null pointer and the effective
user ID of the process does not match the owner of the file and write access is denied.</dd>
<dt>[ELOOP]</dt>
<dd>A loop exists in symbolic links encountered during resolution of the <i>path</i> argument.</dd>
<dt>[ENAMETOOLONG]</dt>
<dd>
The length of the <i>path</i> argument exceeds {PATH_MAX} or a pathname component is longer than {NAME_MAX}.</dd>
<dt>[ENOENT]</dt>
<dd>A component of <i>path</i> does not name an existing file or <i>path</i> is an empty string.</dd>
<dt>[ENOTDIR]</dt>
<dd>A component of the path prefix is not a directory.</dd>
<dt>[EPERM]</dt>
<dd>The <i>times</i> argument is not a null pointer and the calling process' effective user ID has write access to the file but
does not match the owner of the file and the calling process does not have the appropriate privileges.</dd>
<dt>[EROFS]</dt>
<dd>The file system containing the file is read-only.</dd>
</dl>
<p>The <i>utimes</i>() function may fail if:</p>
<dl compact>
<dt>[ELOOP]</dt>
<dd>More than {SYMLOOP_MAX} symbolic links were encountered during resolution of the <i>path</i> argument.</dd>
<dt>[ENAMETOOLONG]</dt>
<dd>
Pathname resolution of a symbolic link produced an intermediate result whose length exceeds {PATH_MAX}.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_807_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_807_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>For applications portability, the <a href="../functions/utime.html"><i>utime</i>()</a> function should be used to set file
access and modification times instead of <i>utimes</i>().</p>
</blockquote>
<h4><a name="tag_03_807_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_807_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>This function may be withdrawn in a future version.</p>
</blockquote>
<h4><a name="tag_03_807_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="utime.html"><i>utime</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/sys/time.h.html"><i>&lt;sys/time.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_807_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 4, Version 2.</p>
</blockquote>
<h4><a name="tag_03_807_12"></a>Issue 5</h4>
<blockquote>
<p>Moved from X/OPEN UNIX extension to BASE.</p>
</blockquote>
<h4><a name="tag_03_807_13"></a>Issue 6</h4>
<blockquote>
<p>This function is marked LEGACY.</p>
<p>The DESCRIPTION is updated to avoid use of the term &quot;must&quot; for application requirements.</p>
<p>The wording of the mandatory [ELOOP] error condition is updated, and a second optional [ELOOP] error condition is added.</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>