235 lines
6.0 KiB
HTML
235 lines
6.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>Qp0zGetTimeofDay()--Get Current Software Clock Time</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>Qp0zGetTimeofDay()--Get Current Software Clock Time</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <sys/time.h>
|
|
|
|
int Qp0zGetTimeofDay (struct timeval *<var>tp</var>,
|
|
struct timezone *<var>tzp</var>);
|
|
</pre>
|
|
|
|
<br>
|
|
Service Program Name: QP0ZCPA<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>Qp0zGetTimeofDay()</strong> function retrieves the
|
|
current software clock time and places it in the timeval structure pointed
|
|
to by <var>tp</var>. If <var>tzp</var> is not NULL, the time zone information
|
|
is returned in the timezone structure pointed to by <var>tzp</var>.</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="gettod.htm">gettimeofday()</a> function should be used instead.
|
|
</p>
|
|
|
|
<br>
|
|
<h3>Parameters</h3>
|
|
|
|
<dl>
|
|
<dt><strong>tp</strong></dt>
|
|
|
|
<dd>(Output) A pointer to a timeval structure that contains the time in seconds
|
|
and microseconds since 1 January 1970, 00:00:00 UTC (epoch-1970).<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>tzp</strong></dt>
|
|
|
|
<dd>(Output) A pointer to a timezone structure that contains the local time
|
|
zone (measured in minutes west of Greenwich) and a flag that, if
|
|
nonzero, indicates daylight saving time applies locally during the appropriate
|
|
part of the year.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>None</p>
|
|
|
|
<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>Qp0zGetTimeofDay()</strong> was
|
|
successful.<br>
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>-1</em></td>
|
|
<td align="left" valign="top"><strong>Qp0zGetTimeofDay()</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>Qp0zGetTimeofDay()</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>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3>Error Messages</h3>
|
|
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Usage Notes</h3>
|
|
|
|
<ul>
|
|
<li>For the best performance, specify NULL for the <var>tzp</var> parameter.</li>
|
|
|
|
<li>If the value of the environment variable QIBM_USE_SFWCLK is "N",
|
|
<strong>Qp0zGetTimeofDay()</strong> calls <strong>gettimeofday()</strong> to
|
|
get the current UTC time from the system clock.</li>
|
|
</ul>
|
|
|
|
<br>
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li>The <<strong>sys/time.h</strong>> file (see <a href=
|
|
"unix13.htm">Header Files for UNIX-Type Functions</a>)<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li><a href="gettod.htm">gettimeofday()--Get Current UTC Time</a><br>
|
|
<br>
|
|
</li>
|
|
|
|
<li><a href="qp0zadjtime.htm">Qp0zAdjTime()--Adjust Software Clock</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 gets the current software clock time:</p>
|
|
|
|
<pre>
|
|
#include <sys/time.h>
|
|
#include <stdio.h>
|
|
#include <errno.h>
|
|
|
|
int main(int argc, char *argv[])
|
|
{
|
|
struct timeval now;
|
|
int rc;
|
|
|
|
rc=Qp0zGetTimeofDay(&now, NULL);
|
|
if(rc==0) {
|
|
printf("Qp0zGetTimeofDay() successful.\n");
|
|
printf("time = %u.%06u\n",
|
|
now.tv_sec, now.tv_usec);
|
|
}
|
|
else {
|
|
printf("Qp0zGetTimeofDay() failed, errno = %d\n",
|
|
errno);
|
|
return -1;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
</pre>
|
|
|
|
<h3>Example Output:</h3>
|
|
|
|
<pre>
|
|
Qp0zGetTimeofDay() successful.
|
|
time = 866208142.290944
|
|
</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>
|
|
|