friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0332907f0f
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qwcrtvtz.htm

962 lines
33 KiB
HTML
Raw Normal View History

Add readme and dist folders
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>Retrieve Time Zone Description (QWCRTVTZ) 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. -->
<!-- created by novey on 02 feb 2003 -->
<!-- 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>Retrieve Time Zone Description (QWCRTVTZ) 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%">Receiver variable
</td><td align="left" valign="top" width="20%">Output
</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 receiver 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">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">Time zone description
</td><td align="left" valign="top">Input
</td><td align="left" valign="top">Char(10)
</td></tr><tr>
<td align="center" valign="top">5
</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 Retrieve Time Zone Description (QWCRTVTZ) API retrieves information about
one or more time zone descriptions. A time zone description contains information
that is used to calculate a local time.
</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><strong>Time Zone Description Authority</strong></dt>
<dd>*USE<br><br></dd>
<dt><strong>Message File Authority</strong></dt>
<dd>*USE is required to retrieve the abbreviated and full names
if a message is specified in the time zone description.<br><br></dd>
<dt><strong>QSYS Library Authority</strong></dt>
<dd>*USE<br><br></dd>
<dt><strong>Message File Library Authority</strong></dt>
<dd>*EXECUTE is required to retrieve the abbreviated and full names
if a message is specified in the time zone description.<br><br></dd>
<dt><strong>Time Zone Description Lock</strong></dt>
<dd>*SHRNUP<br><br></dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The variable to receive the information about the time zone descriptions.</p></dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable. The length must be at least 8 bytes.</p></dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the time zone description information. The possible format name is:</p>
</dl>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>RTMZ0100</em></td>
<td align="left" valign="top">See <a href="#HDRXXRTMZ1">Format RTMZ0100</a> for details on the time zone
description information returned.</td>
</tr><tr>
<td align="left" valign="top"><em>RTMZ0200</em></td>
<td align="left" valign="top">See <a href="#HDRXXRTMZ2">Format RTMZ0200</a> for details on the time zone description information returned.</td>
</tr>
</table>
<br>
<dl>
<dt><strong>Time zone description</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the time zone description for which information is to be retrieved. This name can be a simple object name, a generic name or the following special value:</p>
</dl>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Retrieve information for all time zone descriptions.</td>
</tr>
</table>
<br>
<dl>
<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="HDRXXRTMZ1">Format RTMZ0100</a></h3>
<p>The RTMZ0100 format returns the following information for the
specified time zone description.</p>
<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" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of time zone descriptions available</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to time zone descriptions</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of time zone descriptions returned</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of a time zone description entry</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="22" colspan="2">These fields repeat, in
the order listed, for the number of time zone descriptions returned.</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Time zone description name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Local system time indicator</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Daylight Saving Time indicator</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset from UTC</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Standard Time abbreviated name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Standard Time full name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Daylight Saving Time abbreviated name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Daylight Saving Time full name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Standard Time message</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Daylight Saving Time message</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message file name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message file library name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Daylight Saving Time start - month</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Daylight Saving Time start - day</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Daylight Saving Time start - relative day of month</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Daylight Saving Time start - time</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Daylight Saving Time end - month</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Daylight Saving Time end - day</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Daylight Saving Time end - relative day of month</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Daylight Saving Time end - time</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<h3><a name="HDRXXRTMZ2">Format RTMZ0200</a></h3>
<p>The RTMZ0200 format returns the following information for the
specified time zone description.</p>
<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" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of time zone descriptions available</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to time zone descriptions</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of time zone descriptions returned</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="6" colspan="2">These fields repeat, in
the order listed, for the number of time zone descriptions returned.</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of this time zone description entry</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to TZ string</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of TZ string</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Time zone description name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">TZ string</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Bytes available.</strong>&nbsp;&nbsp;
The number of bytes of data available to be returned. All available data is returned if enough space is provided.</p>
<p><strong>Bytes returned.</strong>&nbsp;&nbsp;
The number of bytes of data returned.</p>
<p><strong>Daylight Saving Time abbreviated name.</strong>&nbsp;&nbsp;
The abbreviated name used with the time zone when Daylight Saving Time is being observed. If the time zone description does not support Daylight Saving Time, this field is blank. If the time zone description uses a message to specify the abbreviated name and the message cannot be retrieved, this field returns *N. This can occur when the caller of the API is not authorized to the message file or its library, the message file cannot be found or the message does not exist in the specified message file.</p>
<p><strong>Daylight Saving Time end - day.</strong>&nbsp;&nbsp;
The day of the week on which Daylight Saving Time ends. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">This time zone description does not support
Daylight Saving Time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Daylight Saving Time ends on a Monday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Daylight Saving Time ends on a Tuesday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Daylight Saving Time ends on a Wednesday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Daylight Saving Time ends on a Thursday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">Daylight Saving Time ends on a Friday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Daylight Saving Time ends on a Saturday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">Daylight Saving Time ends on a Sunday.</td>
</tr>
</table>
<p><strong>Daylight Saving Time end - month.</strong>&nbsp;&nbsp;
The month in which Daylight Saving Time ends. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">This time zone description does not support
Daylight Saving Time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>01</em></td>
<td align="left" valign="top">Daylight Saving Time ends in January.</td>
</tr>
<tr>
<td align="left" valign="top"><em>02</em></td>
<td align="left" valign="top">Daylight Saving Time ends in February.</td>
</tr>
<tr>
<td align="left" valign="top"><em>03</em></td>
<td align="left" valign="top">Daylight Saving Time ends in March.</td>
</tr>
<tr>
<td align="left" valign="top"><em>04</em></td>
<td align="left" valign="top">Daylight Saving Time ends in April.</td>
</tr>
<tr>
<td align="left" valign="top"><em>05</em></td>
<td align="left" valign="top">Daylight Saving Time ends in May.</td>
</tr>
<tr>
<td align="left" valign="top"><em>06</em></td>
<td align="left" valign="top">Daylight Saving Time ends in June.</td>
</tr>
<tr>
<td align="left" valign="top"><em>07</em></td>
<td align="left" valign="top">Daylight Saving Time ends in July.</td>
</tr>
<tr>
<td align="left" valign="top"><em>08</em></td>
<td align="left" valign="top">Daylight Saving Time ends in August.</td>
</tr>
<tr>
<td align="left" valign="top"><em>09</em></td>
<td align="left" valign="top">Daylight Saving Time ends in September.</td>
</tr>
<tr>
<td align="left" valign="top"><em>10</em></td>
<td align="left" valign="top">Daylight Saving Time ends in October.</td>
</tr>
<tr>
<td align="left" valign="top"><em>11</em></td>
<td align="left" valign="top">Daylight Saving Time ends in November.</td>
</tr>
<tr>
<td align="left" valign="top"><em>12</em></td>
<td align="left" valign="top">Daylight Saving Time ends in December.</td>
</tr>
</table>
<p><strong>Daylight Saving Time end - relative day of month.</strong>&nbsp;&nbsp;
The relative day of the month on which Daylight Saving Time ends. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">This time zone description does not support Daylight Saving Time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Daylight Saving Time ends on the first occurrence of the specified day of the week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Daylight Saving Time ends on the second occurrence of the specified day of the week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Daylight Saving Time ends on the third occurrence of the specified day of the week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Daylight Saving Time ends on the fourth occurrence of the specified day of the week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>L</em></td>
<td align="left" valign="top">Daylight Saving Time ends on the last occurrence of the specified day of the week.</td>
</tr>
</table>
<p><strong>Daylight Saving Time end - time.</strong>&nbsp;&nbsp;
The time of day at which Daylight Saving Time ends. The time is specified in the form hhmmss, where hh = hours, mm = minutes and ss = seconds. If the time zone description does not support Daylight Saving Time, this field is blank.</p>
<p><strong>Daylight Saving Time full name.</strong>&nbsp;&nbsp;
The full name of the time zone when Daylight Saving Time is being observed. If the time zone description does not support Daylight Saving Time, this field is blank. If the time zone description uses a message to specify the full name and the message cannot be retrieved, this field returns *N. This can occur when the caller of the API is not authorized to the message file or its library, the message file cannot be found or the message does not exist in the specified message file.</p>
<p><strong>Daylight Saving Time indicator.</strong>&nbsp;&nbsp;
Indicates whether or not the time zone description supports Daylight Saving Time.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">This time zone description does not support Daylight Saving Time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This time zone description supports Daylight Saving Time.</td>
</tr>
</table>
<p><strong>Daylight Saving Time message.</strong>&nbsp;&nbsp;
The message that contains the abbreviated and full names of the time zone
when Daylight Saving Time is being observed.
If the time zone description does not support Daylight Saving Time,
this field is blank.
If a message was not specified when the time zone description
was created or last changed, this field returns *NONE.</p>
<p><strong>Daylight Saving Time start - day.</strong>&nbsp;&nbsp;
The day of the week on which Daylight Saving Time starts. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">This time zone description does not support
Daylight Saving Time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Daylight Saving Time starts on a Monday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Daylight Saving Time starts on a Tuesday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Daylight Saving Time starts on a Wednesday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Daylight Saving Time starts on a Thursday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">Daylight Saving Time starts on a Friday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Daylight Saving Time starts on a Saturday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">Daylight Saving Time starts on a Sunday.</td>
</tr>
</table>
<p><strong>Daylight Saving Time start - month.</strong>&nbsp;&nbsp;
The month in which Daylight Saving Time starts. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">This time zone description does not support
Daylight Saving Time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>01</em></td>
<td align="left" valign="top">Daylight Saving Time starts in January.</td>
</tr>
<tr>
<td align="left" valign="top"><em>02</em></td>
<td align="left" valign="top">Daylight Saving Time starts in February.</td>
</tr>
<tr>
<td align="left" valign="top"><em>03</em></td>
<td align="left" valign="top">Daylight Saving Time starts in March.</td>
</tr>
<tr>
<td align="left" valign="top"><em>04</em></td>
<td align="left" valign="top">Daylight Saving Time starts in April.</td>
</tr>
<tr>
<td align="left" valign="top"><em>05</em></td>
<td align="left" valign="top">Daylight Saving Time starts in May.</td>
</tr>
<tr>
<td align="left" valign="top"><em>06</em></td>
<td align="left" valign="top">Daylight Saving Time starts in June.</td>
</tr>
<tr>
<td align="left" valign="top"><em>07</em></td>
<td align="left" valign="top">Daylight Saving Time starts in July.</td>
</tr>
<tr>
<td align="left" valign="top"><em>08</em></td>
<td align="left" valign="top">Daylight Saving Time starts in August.</td>
</tr>
<tr>
<td align="left" valign="top"><em>09</em></td>
<td align="left" valign="top">Daylight Saving Time starts in September.</td>
</tr>
<tr>
<td align="left" valign="top"><em>10</em></td>
<td align="left" valign="top">Daylight Saving Time starts in October.</td>
</tr>
<tr>
<td align="left" valign="top"><em>11</em></td>
<td align="left" valign="top">Daylight Saving Time starts in November.</td>
</tr>
<tr>
<td align="left" valign="top"><em>12</em></td>
<td align="left" valign="top">Daylight Saving Time starts in December.</td>
</tr>
</table>
<p><strong>Daylight Saving Time start - relative day of month.</strong>&nbsp;&nbsp;
The relative day of the month on which Daylight Saving Time starts. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">This time zone description does not support Daylight Saving Time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Daylight Saving Time starts on the first occurrence of the specified day of the week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Daylight Saving Time starts on the second occurrence of the specified day of the week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Daylight Saving Time starts on the third occurrence of the specified day of the week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Daylight Saving Time starts on the fourth occurrence of the specified day of the week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>L</em></td>
<td align="left" valign="top">Daylight Saving Time starts on the last occurrence of the specified day of the week.</td>
</tr>
</table>
<p><strong>Daylight Saving Time start - time.</strong>&nbsp;&nbsp;
The time of day at which Daylight Saving Time starts. The time is specified in the form hhmmss, where hh = hours, mm = minutes and ss = seconds. If the time zone description does not support Daylight Saving Time, this field is blank.</p>
<p><strong>Displacement to TZ string.</strong>&nbsp;&nbsp;
The displacement, in bytes, from the beginning of this time zone description to the <strong>TZ string</strong>.</p>
<p><strong>Length of a time zone description entry.</strong>&nbsp;&nbsp;
The length of a single time zone description entry in the receiver variable.</p>
<p><strong>Length of this time zone description entry.</strong>&nbsp;&nbsp;
The length of this time zone description entry. This value is the number of bytes from the start of the time zone description entry to the start of the next entry (if any) in the receiver variable.</p>
<p><strong>Length of TZ string.</strong>&nbsp;&nbsp;
The length in bytes of the <strong>TZ string</strong>, excluding the terminating null at the end of the string.</p>
<p><strong>Local system time indicator.</strong>&nbsp;&nbsp;
Indicates whether or not the time zone description is currently specified in the Time zone (QTIMZON) system value. The time zone description specified in the QTIMZON system value is used to calculate local system time and cannot be deleted.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">This time zone description is not currently specified in the QTIMZON system value.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This time zone description is currently specified in the QTIMZON system value.</td>
</tr>
</table>
<p><strong>Message file library name.</strong>&nbsp;&nbsp;
The name of the library containing the message file used to retrieve the Standard Time message and the Daylight Saving Time message. The field may contain *LIBL which means that the library list is searched to locate the message file. The library name is left-justified and padded with blanks on the right. If the message file name specifies *NONE, this field returns blanks.</p>
<p><strong>Message file name.</strong>&nbsp;&nbsp;
The name of the message file used to retrieve the Standard Time message and the Daylight Saving Time message. The message file name is left-justified and padded with blanks on the right. If a message was not specified when the time zone description was created or last changed, this field returns *NONE.</p>
<p><strong>Number of time zone descriptions available.</strong>&nbsp;&nbsp;
The number of time zone descriptions that match the time zone description name specified on the call to this API. This is the number of time zone descriptions which the caller of the API has *USE authority to.</p>
<p><strong>Number of time zone descriptions returned.</strong>&nbsp;&nbsp;
The number of time zone descriptions returned in the receiver variable.</p>
<p><strong>Offset from UTC.</strong>&nbsp;&nbsp;
The time difference, in minutes, between this time zone and Coordinated Universal Time (UTC). This value is subtracted from local time to obtain UTC time. A negative difference indicates that the time zone is west of UTC and a positive difference indicates that the time zone is east of UTC.</p>
<p><strong>Offset to time zone descriptions.</strong>&nbsp;&nbsp;
The offset in bytes from the beginning of the receiver variable to the first time zone description.</p>
<p><strong>Reserved.</strong>&nbsp;&nbsp;
An unused field.</p>
<p><strong>Standard Time abbreviated name.</strong>&nbsp;&nbsp;
The abbreviated name used with the time zone when Daylight Saving Time is not being observed. If the time zone description uses a message to specify the abbreviated name and the message cannot be retrieved, this field returns *N. This can occur when the caller of the API is not authorized to the message file or its library, the message file cannot be found or the message does not exist in the specified message file.</p>
<p><strong>Standard Time full name.</strong>&nbsp;&nbsp;
The full name of the time zone when Daylight Saving Time is not being observed. If the time zone description uses a message to specify the full name and the message cannot be retrieved, this field returns *N. This can occur when the caller of the API is not authorized to the message file or its library, the message file cannot be found or the message does not exist in the specified message file.</p>
<p><strong>Standard Time message.</strong>&nbsp;&nbsp;
The message that contains the abbreviated and full names of the time zone when Daylight Saving Time is not being observed. If a message was not specified when the time zone description was created or last changed, this field returns *NONE.</p>
<p><strong>Text description.</strong>&nbsp;&nbsp;
The user text, if any, used to briefly describe the time zone description.</p>
<p><strong>Time zone description name.</strong>&nbsp;&nbsp;
The name of the time zone description object.</p>
<p><strong>TZ string.</strong>&nbsp;&nbsp;
A null-terminated character string that describes the time zone in a format compatible with industry standards. The returned string may be used to set i5/OS PASE environment variable TZ, and has this format (spaces inserted for readability):</p>
<pre>
std offset dst offset , start/time , end/time
</pre>
<p>An example of a TZ value for time zone QN0600CST (USA Central time) is "CST6CDT,M4.1.0,M10.5.0". Daylight Saving Time specifications (dst, offset, start/time, and end/time) are omitted if the time zone does not use Daylight Saving Time.</p>
<dl>
<dt><tt>std</tt></dt>
<dd>This is the <strong>Standard Time abbreviated name</strong> string, stripped of trailing blanks and replacing any characters not allowed by standards with asterisks (nulls, decimal digits, plus sign, minus sign, comma, and leading colon).</dd>
<dt><tt>offset</tt></dt>
<dd>Hours and minutes behind Coordinated Universal Time (UTC). Minutes are omitted if the time zone is an integral number of hours behind UTC. <tt>offset</tt> is formatted as hh:mm if minutes are included, and has a leading minus sign if the value is negative. A negative value indicates the time zone is east of UTC, which is the opposite of the <strong>Offset from UTC</strong> field (in format <strong>RTMZ0100</strong>).</dd>
<dt><tt>dst</tt></dt>
<dd>This is the <strong>Daylight Saving Time abbreviated name</strong> string, stripped of trailing blanks and replacing any characters not allowed by standards with asterisks (nulls, decimal digits, plus sign, minus sign, comma, and leading colon).</dd>
<dt><tt>start/time</tt></dt>
<dd>Specifies when Daylight Saving Time starts. <tt>start</tt> includes the month (1-12), week number (1-5), and day (0-6, for Sunday-Saturday) in the form <tt>Mm.n.d</tt>. <tt>time</tt> is formatted as <tt>hh:mm:ss</tt>, but is omitted if Daylight Saving Time starts at 2:00:00.</dd>
<dt><tt>end/time</tt></dt>
<dd>Specifies when Daylight Saving Time ends. <tt>end</tt> includes the month (1-12), week number (1-5), and day (0-6, for Sunday-Saturday) in the form <tt>Mm.n.d</tt>. <tt>time</tt> is formatted as <tt>hh:mm:ss</tt>, but is omitted if Daylight Saving Time ends at 2:00:00.</dd>
</dl>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C19 E</td>
<td align="left" valign="top">Error occurred with receiver variable
specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C24 E</td>
<td align="left" valign="top">Length of the receiver variable is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8130 E</td>
<td align="left" valign="top">Time zone description &amp;1 damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" 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>
Reference in New Issue Copy Permalink