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

288 lines
7.4 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>Adjust Time (QWCADJTM) API</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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--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>Adjust Time (QWCADJTM) API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Adjustment variable</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of adjustment variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Adjustment format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Error Code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: YES<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>
The Adjust Time (QWCADJTM) API will adjust the time by increasing or decreasing the time-of-day clock to a maximum change of plus or minus two hours.
</p>
<p><strong>Note:</strong> A time-of-day adjustment will remain active until completed unless one of the following occurs:</p>
<ul>
<li>A new time-of-day clock adjustment is started for the system.</li>
<li>The time-of-day clock for the system is changed.</li>
<li>The system is powered off.</li>
</ul>
<p>
The Retrieve System Time Information(QWCRTVTM) API can be used to determine if an adjustment to the time-of-day clock is allowed and can be used to retrieve information on any time adjustment that may be currently active.
</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Special Authority</em></dt>
<dd>*ALLOBJ</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Adjustment variable</strong></dt>
<dd>INPUT; CHAR(*)
<p>
The variable that is used to specify the time adjustment details.
</p>
</dd>
<dt><strong>Length of adjustment variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>
The length of the adjustment variable. Minimum length is 9 bytes.
</p>
</dd>
<dt><strong>Adjustment format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>
The format name of the adjustment variable. The possible format name is:
</p>
<dl compact>
<dt><em>ADJT0100</em></dt>
<dd>Basic time adjustment details.</dd>
</dl>
<p>
See <a href="#ADJVAR">Format of Adjustment Variable</a> for more information.
</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>
The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.
</p>
</dd>
</dl>
<br>
<h3><a name="ADJVAR">Format of Adjustment Variable</a></h3>
<p>
The following table describes the order and format of the data that is specified in the adjustment variable.
For detailed descriptions of the fields in this table, see <a href="#FLDDESC2">Field Descriptions</a>.
</p>
<h3>ADJT0100</h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
<td align="left" valign="top">Time adjustment amount</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Time adjustment direction</td>
</tr>
</table>
<br>
<h3><a name="FLDDESC2">Field Descriptions</a></h3>
<p><strong>Time adjustment amount.</strong> The time value which specifies the amount of time in microseconds by which the time-of-day clock will be increased or decreased.</p>
<p><strong>Note:</strong> The maximum value for the time adjustment interval is two hours.</p>
<p><strong>Time adjustment direction.</strong> The direction of the time-of-day clock adjustment for the system.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Increase time of day.</td>
</tr>
<tr>
<td align="left" valigh="top"><em>1</em></td>
<td align="left" valigh="top">Decrease time of day.</td>
</tr>
</table>
<br>
<h3><a name="header_9">Error Messages</a></h3>
<p>The following messages may be sent from this function:</p>
<table width="100%">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF1890 E</td>
<td width="85%" valign="top">*ALLOBJ authority required for requested operation.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF18C5 E</td>
<td width="85%" valign="top">Time adjustment not valid.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF3C12 E</td>
<td valign="top">Length of data is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C21 E</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for
this API was not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C3C E</td>
<td valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF2 E</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPF9821 E</td>
<td valign="top">Not authorized to program &amp;1 in library &amp;2.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<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=
"catdate.htm">Date and Time APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>