ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qp0zadjtime.htm

263 lines
7.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Qp0zAdjTime()--Adjust Software Clock</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Feb 02 -->
<!-- 0300918 JETAYLOR html cleanup -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Qp0zAdjTime()--Adjust Software Clock</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;sys/time.h&gt;
int Qp0zAdjTime (struct timeval *<var>delta</var>,
struct timeval *<var>olddelta</var>);
</pre>
<br>
&nbsp;&nbsp;Service Program Name: QP0ZSETC<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>Qp0zAdjTime()</strong> function makes small adjustments to the
software clock, either slowing it down or speeding it up by the time specified in the
<var>delta</var> parameter. If <var>delta</var> is negative, the clock is
slowed down by incrementing it more slowly than normal until the correction is
complete. If <var>delta</var> is positive, the clock is sped up by incrementing
it more quickly than normal until the correction is complete. If
<var>olddelta</var> is not NULL, the amount of time still to be corrected from
a previous <strong>Qp0zAdjTime()</strong> call is returned in the structure it
points to.</p>
<p>
The software clock maintains a time that can be set independently of the system
clock. It is not integrated with the system and will be removed in a future
release. The <a href="adjtime.htm">adjtime()</a> function should be used instead.
</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>delta</strong></dt>
<dd>(Input) A pointer to a timeval structure that contains the amount of time
for adjusting the software clock.<br>
<br>
</dd>
<dt><strong>olddelta</strong></dt>
<dd>(Output) A pointer to a timeval structure that contains the amount of time
still to be corrected from a previous call to <strong>Qp0zAdjTime()</strong></dd>
</dl>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>QSYS/QP0ZXCPA Service Program Authority</em></dt>
<dd>*USE</dd>
</dl>
<br>
<h3>Return Value</h3>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top"><strong>Qp0zAdjTime()</strong> was successful. The
requested adjustment was initiated and the value returned in the structure
pointed to by the <var>olddelta</var> parameter is the amount of time still to
be corrected from a previous <strong>Qp0zAdjTime()</strong>.<br>
<br>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top"><strong>Qp0zAdjTime()</strong> was not successful.
The <var>errno</var> variable is set to indicate the error.</td>
</tr>
</table>
<br>
<br>
<h3>Error Conditions</h3>
<p>If <strong>Qp0zAdjTime()</strong> is not successful, <var>errno</var> usually
indicates one of the following errors. Under some conditions, <var>errno</var>
could indicate an error other than those listed here.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>[EINVAL]</em></td>
<td align="left" valign="top">An invalid parameter was found.
<p>A parameter passed to this function is not valid.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>[EFAULT]</em></td>
<td align="left" valign="top">The address used for an argument is not correct.
<p>In attempting to use an argument in a call, the system detected an address
that is not valid.</p>
<p>While attempting to access a parameter passed to this function, the system
detected an address that is not valid.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>[EPERM]</em></td>
<td align="left" valign="top">Operation not permitted.
<p>You must have appropriate privileges or be the owner of the object or other
resource to do the requested operation.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>[EUNKNOWN]</em></td>
<td align="left" valign="top">Unknown system state.
<p>The operation failed because of an unknown system state. See any messages in
the job log and correct any errors that are indicated, then retry the
operation.</p>
</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</h3>
<p>None.</p>
<br>
<h3>Usage Notes</h3>
<p>If the value of the environment variable QIBM_USE_SFWCLK is &quot;N&quot;,
<strong>Qp0zAdjTime()</strong> calls <strong>adjtime()</strong> to
adjust the system clock.</p>
<br>
<h3>Related Information</h3>
<ul>
<li>The &lt;<strong>sys/time.h</strong>&gt; file (see <a href=
"unix13.htm">Header Files for UNIX-Type Functions</a>)<br>
<br>
</li>
<li><a href="adjtime.htm">adjtime()--Adjust system clock</a><br>
<br>
</li>
<li><a href="qp0zgettime.htm">Qp0zGetTimeofDay()--Get Current Software Clock Time</a><br>
<br>
</li>
<li><a href="qp0zsettime.htm">Qp0zSetTimeofDay()--Set Software Clock</a></li>
</ul>
<br>
<h3>Example</h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
for information pertaining to code examples.</p>
<p>The following example initiates a software clock adjustment:</p>
<pre>
#include &lt;sys/time.h&gt;
#include &lt;stdio.h&gt;
#include &lt;errno.h&gt;
int main(int argc, char *argv[])
{
struct timeval adj, old;
int rc;
/* Speed up the software clock by 1.5 seconds. */
adj.tv_sec=1;
adj.tv_usec=500000;
rc=Qp0zAdjTime(&amp;adj, &amp;old);
if(rc==0) {
printf(&quot;Qp0zAdjTime() successful. &quot;
&quot;Olddelta = %u.%06u\n&quot;,
old.tv_sec, old.tv_usec);
}
else {
printf(&quot;Qp0zAdjTime() failed, errno = %d\n&quot;,errno);
return -1;
}
return 0;
}
</pre>
<h3>Example Output:</h3>
<pre>
Qp0zAdjTime() successful. Olddelta = 0.000000
</pre>
<br>
<hr>
API introduced: V5R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>