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

233 lines
6.4 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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>Get Universal Time Coordinated (CEEUTC) 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 -->
<!-- ILE4A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at -->
<!-- RCHVMX on 25 Feb 1999 at 10:53:17 -->
<!--Edited by Kersten Oct 2001 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>Get Universal Time Coordinated (CEEUTC) API</h2>
<div class="box" style="width: 65%;">
<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%">output_UTC_Lilian</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">INT4</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">output_UTC_seconds</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">FLOAT8</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Omissible Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="50%">fc</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">FEEDBACK</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program Name: QLEAWI<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 Get Universal Time Coordinated (CEEUTC) API returns the current
Universal Time Coordinated as both a Lilian date and as the number of seconds
since 00:00:00 14 October 1582. These values are compatible with the other ILE
date and time APIs.</p>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>output_UTC_Lilian (output)</strong></dt>
<dd>A 32-bit binary integer representing the current date in Greenwich,
England, in the Lilian format. That is, the number of days since 14 October
1582, also known as Universal Time Coordinated (UTC). For example, 16 May 1988
is day number 148&nbsp;138. If UTC is not available from the system, <em>
output_UTC_Lilian</em> is set to 0 and CEEUTC ends with a nonzero feedback
code.<br>
<br>
</dd>
<dt><strong>output_UTC_seconds (output)</strong></dt>
<dd>A 64-bit double floating-point number representing the current date and
time in Greenwich, England as the number of seconds since 00:00:00 on 14
October 1582. For example, 00:00:01 on 15 October 1582 is second number
86&nbsp;401 (24*60*60 + 01). 19:00:01.078 on 16 May 1988 is second number
12&nbsp;799&nbsp;191&nbsp;601.078. If UTC is not available from the system,
<em>output_UTC_seconds</em> is set to 0 and CEEUTC ends with a nonzero feedback
code.</dd>
</dl>
<br>
<h3>Omissible Parameter</h3>
<dl>
<dt><strong>fc (output)</strong></dt>
<dd>A 12-byte feedback code passed by reference. If specified as an argument,
feedback information (a condition token) is returned to the calling procedure.
If not specified and the requested operation was not successfully completed,
the condition is signaled to the condition manager.</dd>
</dl>
<br>
<h3>Feedback Codes and Conditions</h3>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top">CEE0000</td>
<td align="left" valign="top">The API completed successfully</td>
</tr>
<tr>
<td align="left" valign="top">Severity: 00</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">CEE2502</td>
<td align="left" valign="top">Local time not available</td>
</tr>
<tr>
<td align="left" valign="top">Severity: 30</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">CEE2531</td>
<td align="left" valign="top">UTC not available</td>
</tr>
<tr>
<td align="left" valign="top">Severity: 30</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">CEE9902</td>
<td align="left" valign="top">Unexpected user error occurred in &amp;1</td>
</tr>
<tr>
<td align="left" valign="top">Severity: 30</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<h3>Usage Notes</h3>
<ul>
<li>
<p>Use CEELOCT to obtain local time.</p>
</li>
<li>
<p>Use CEEUTCO to obtain the offset from UTC to local time.</p>
</li>
<li>
<p>The values returned by CEEUTC are handy for <strong>wall-clock</strong>
calculations.</p>
</li>
<li>
<p>CEEDATE will convert <em>output_UTC_Lilian</em> to character date, and
CEEDATM will convert <em>output_UTC_seconds</em> to character timestamp.</p>
</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>
<ul>
<li>
<p>Extract current UTC and convert to local date and time in <samp>
YYMMDDHHMMSS</samp> format:</p>
<pre>
CALL CEEUTC (days, secs, fc);
CALL CEEUTCO (hrs, mins, secoffset, fc);
secs = secs + secoffset;
CALL CEEDATM (secs, 'YYMMDDHHMISS', localdatetime,
fc);
</pre>
</li>
</ul>
<br>
<hr>
API introduced: V2R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"ile1a1.htm">ILE CEE APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>