259 lines
8.2 KiB
HTML
259 lines
8.2 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>Check Target Release (QSZCHKTG) 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. -->
|
||
|
|
<!-- QSZCHKTG SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
|
||
|
|
<!-- at RCHVMW2 on 7 Oct 1998 at 18:09:48 -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- Edited by Kersten Jan 02 -->
|
||
|
|
<!--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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Check Target Release (QSZCHKTG) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
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%">Target release</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Supported i5/OS (OS/400) releases list</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Number of supported i5/OS (OS/400) releases</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Validated target release</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(6)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Equivalent supported i5/OS (OS/400) release</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(6)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</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>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Check Target Release (QSZCHKTG) API verifies that you specified a valid
|
||
|
|
target release value. You can use this API to check a target release value for
|
||
|
|
CL commands that support a TGTRLS keyword parameter. If the target release is a
|
||
|
|
known i5/OS (OS/400) release, this API returns the validated target release. If you
|
||
|
|
specify *CURRENT or *PRV for the target release value, this API returns the
|
||
|
|
equivalent VxRxMx release value.</p>
|
||
|
|
|
||
|
|
<p>This API also determines, from the supported i5/OS (OS/400) releases list parameter,
|
||
|
|
which supported release is the most recent release that is less than or equal
|
||
|
|
to the validated target release.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<p>None</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Target release</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The target release value being checked. The value must be *CURRENT, *PRV, or
|
||
|
|
a 6-character release value in the format VxRxMx where <em>x</em> is a digit
|
||
|
|
from 0 through 9. The 6-character release value must be a known release of
|
||
|
|
i5/OS (OS/400). All values must be left-aligned and padded with blanks.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Supported i5/OS (OS/400) releases list</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The list of i5/OS (OS/400) releases that the caller of this API supports. Each list
|
||
|
|
entry must be a 6-character release value in the format VxRxMx (where
|
||
|
|
<em>x</em> is a digit from 0 through 9) or the special value *SAV.</p>
|
||
|
|
|
||
|
|
<p>A 6-character release value must be a known release of i5/OS (OS/400). All values
|
||
|
|
must be unique and must be in ascending order. If V3R2M0 and V3R6M0 are both in
|
||
|
|
the list, V3R2M0 must precede V3R6M0. The earliest valid i5/OS (OS/400) release value
|
||
|
|
is V1R3M0.</p>
|
||
|
|
|
||
|
|
<p>Assume that the calling function supports the creation of two different
|
||
|
|
versions of an object. The first version can be used on a system that runs
|
||
|
|
i5/OS (OS/400) V3R1M0 (or any later release). The second version can only be used on a
|
||
|
|
system that runs i5/OS (OS/400) V3R7M0 (or any later release). The function would pass
|
||
|
|
V3R1M0V3R7M0 for this parameter and would pass a value of 2 for the number of
|
||
|
|
supported i5/OS (OS/400) releases parameter.</p>
|
||
|
|
|
||
|
|
<p>If *SAV is specified, it must be the only entry in the list. This special
|
||
|
|
value indicates that the caller supports the same set of i5/OS (OS/400) releases as the
|
||
|
|
i5/OS Save Library (SAVLIB) and Save Object (SAVOBJ) commands.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Number of supported i5/OS (OS/400) releases</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The number of list entries passed in the supported i5/OS (OS/400) releases list
|
||
|
|
parameter. This parameter must have a value of 1 or greater. The value must be
|
||
|
|
1 if *SAV is specified in the supported i5/OS (OS/400) releases list.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Validated target release</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(6)
|
||
|
|
|
||
|
|
<p>The validated target release being returned. If the input target release is
|
||
|
|
*CURRENT or *PRV, this parameter contains the equivalent VxRxMx value. If the
|
||
|
|
input target release is a known i5/OS (OS/400) release, the API copies the value to
|
||
|
|
this parameter and returns the value. If the input target release value is not
|
||
|
|
*CURRENT, *PRV, or a known i5/OS (OS/400) release in VxRxMx format, the API returns
|
||
|
|
blanks for this parameter.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Equivalent supported i5/OS (OS/400) release</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(6)
|
||
|
|
|
||
|
|
<p>The release list entry being returned, from the supported i5/OS (OS/400) releases
|
||
|
|
list parameter, that is the most recent release that is less than or equal to
|
||
|
|
the validated target release. If the input target release value is not valid,
|
||
|
|
the API returns blanks. If the input target release is less than the first list
|
||
|
|
entry in the supported i5/OS (OS/400) releases list parameter, the API sends message
|
||
|
|
CPF0C35 and returns blanks.</p>
|
||
|
|
|
||
|
|
<p>If *SAV is specified in the supported i5/OS (OS/400) releases list, the API returns
|
||
|
|
the validated target release.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</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>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<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">CPF0C31 E</td>
|
||
|
|
<td width="85%" valign="top">&1 not valid for number of supported i5/OS (OS/400)
|
||
|
|
releases.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0C32 E</td>
|
||
|
|
<td align="left" valign="top">List of supported i5/OS (OS/400) releases not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0C33 E</td>
|
||
|
|
<td align="left" valign="top">Target release &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0C34 E</td>
|
||
|
|
<td align="left" valign="top">Release &1 is not a valid i5/OS (OS/400)
|
||
|
|
release.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0C35 E</td>
|
||
|
|
<td align="left" valign="top">Target release &1 is not a supported
|
||
|
|
release.</td>
|
||
|
|
</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>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V3R7
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"sw1.htm">Software Product APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|