877 lines
26 KiB
HTML
877 lines
26 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>Retrieve Sort Sequence Table (QLGRTVSS) 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. -->
|
|
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
|
|
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited December 2001 -->
|
|
<!--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>Retrieve Sort Sequence Table (QLGRTVSS) API</h2>
|
|
|
|
<div class="box" style="width: 65%;">
|
|
<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%">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">Qualified table name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Language identifier requested</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">CCSID of returned table</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</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">7</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: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Retrieve Sort Sequence Table (QLGRTVSS) API returns a sort sequence
|
|
table based on the required input parameters. It will also return some
|
|
associated job information.</p>
|
|
|
|
<br>
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Sort Sequence Table Authority</em></dt>
|
|
|
|
<dd>*USE<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>Sort Sequence Table Library Authority</em></dt>
|
|
|
|
<dd>*USE<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>Sort Sequence Table Lock</em></dt>
|
|
|
|
<dd>*SHRNUP</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The receiver variable that receives the information requested. You can
|
|
specify the size of the area to be smaller than the format requested, provided
|
|
you specify the length of receiver variable parameter correctly. As a result,
|
|
the API returns only the data the area can hold.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable. If the length is larger than the size
|
|
of the receiver variable, the results are not predictable. The minimum length
|
|
is 8 bytes.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Qualified table name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The sort sequence table to retrieve. The first 10 characters contain the
|
|
table name, and the second 10 characters contain the name of the library in
|
|
which the table resides.</p>
|
|
|
|
<p>The following special values are supported for the table name. These values
|
|
must be in uppercase, left-justified, and padded with blanks to the right of
|
|
the value.</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*JOB</em></td>
|
|
<td align="left" valign="top">The sort sequence of the job.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*JOBRUN</em></td>
|
|
<td align="left" valign="top">The API treats this value the same as *JOB.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LANGIDUNQ</em></td>
|
|
<td align="left" valign="top">The unique-weight sort sequence table that is associated with
|
|
the language identifier requested parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LANGIDSHR</em></td>
|
|
<td align="left" valign="top">The shared-weight sort sequence table that is associated with
|
|
the language identifier requested parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*HEX</em></td>
|
|
<td align="left" valign="top">The sort sequence according to the hexadecimal value of the
|
|
characters.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> Both *JOB and *JOBRUN are accepted to accommodate
|
|
calls from other programs that accept both values and for which the two have
|
|
different semantics.</p>
|
|
|
|
<p>The following special values are supported for the library name. These
|
|
values must be in uppercase, left-justified, and padded with blanks to the
|
|
right of the value.</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">The user's library list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The current library.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If a special value is used for the table name, the second 10 characters used
|
|
for the library name must be blank.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Language identifier requested</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The language identifier of the sort sequence table to be used. All values
|
|
must be in uppercase and must be padded with blanks to the right of the value.
|
|
This value will be ignored if the value of the table name parameter is a table
|
|
object or *HEX. Valid values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*JOB</em></td>
|
|
<td align="left" valign="top">Use the language identifier of the job.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*JOBRUN</em></td>
|
|
<td align="left" valign="top">The API treats this value the same as *JOB.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Specific language identifier</em></td>
|
|
<td align="left" valign="top">A valid 3-character language identifier. For example, Danish
|
|
would be "DAN". See the <a href="../nls/rbagsglobalmain.htm">globalization</a>
|
|
topic for a complete list of valid language identifiers.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> Both *JOB and *JOBRUN are accepted to accommodate
|
|
calls from other programs that accept both values and for which the two have
|
|
different semantics.</p>
|
|
</dd>
|
|
|
|
<dt><strong>CCSID of returned table</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The coded character set identifier (CCSID) in which the sort sequence table
|
|
should be returned. The valid values for this parameter are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The CCSID of the job will be used to determine the CCSID of
|
|
the sort sequence table to be returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1-65533</em></td>
|
|
<td align="left" valign="top">A valid CCSID in this range.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>65535</em></td>
|
|
<td align="left" valign="top">The CCSID of the sort sequence table that is found should be
|
|
used. No CCSID conversion should be done on the found table.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The content and format of the information returned for each table. The
|
|
format name is:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>RSST0100</em></td>
|
|
<td align="left" valign="top">Sort sequence format for single-byte sort sequence table.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>See <a href="#HDRRSSFMT">RSST0100 Format</a> for a description of this
|
|
format.</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>RSST0200</em></td>
|
|
<td align="left" valign="top">Sort sequence format for a single-byte or UCS-2 sort sequence
|
|
table.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>See <a href="#HDRRSSFMT2">RSST0200 Format</a> for a description of this
|
|
format.</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="HDRRSSFMT">RSST0100 Format</a></h3>
|
|
|
|
<p>Following is the format of the information returned. For a description of
|
|
the fields in this format, see <a href="#HDRRSSFLD">Field Descriptions</a>.</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 valign="bottom" align="center">Dec</th>
|
|
<th valign="bottom" align="center">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 available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">4</td>
|
|
<td align="center" valign="TOP" width="10%">4</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" width="10%">8</td>
|
|
<td align="center" valign="TOP" width="10%">8</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Job CCSID value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">12</td>
|
|
<td align="center" valign="TOP" width="10%">C</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">CCSID of returned table</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">16</td>
|
|
<td align="center" valign="TOP" width="10%">10</td>
|
|
<td align="left" valign="top" width="20%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="60%">Substitution values encountered</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">17</td>
|
|
<td align="center" valign="TOP" width="10%">11</td>
|
|
<td align="left" valign="top" width="20%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="60%">Weighting of returned sort sequence
|
|
table</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">18</td>
|
|
<td align="center" valign="TOP" width="10%">12</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Returned table name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">28</td>
|
|
<td align="center" valign="TOP" width="10%">1C</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Returned table library name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">38</td>
|
|
<td align="center" valign="TOP" width="10%">26</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Job sort sequence table name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">48</td>
|
|
<td align="center" valign="TOP" width="10%">30</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Job sort sequence table library
|
|
name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">58</td>
|
|
<td align="center" valign="TOP" width="10%">3A</td>
|
|
<td align="left" valign="top" width="20%">CHAR(3)</td>
|
|
<td align="left" valign="top" width="60%">Job language identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">61</td>
|
|
<td align="center" valign="TOP" width="10%">3D</td>
|
|
<td align="left" valign="top" width="20%">CHAR(2)</td>
|
|
<td align="left" valign="top" width="60%">Job country or region identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">63</td>
|
|
<td align="center" valign="TOP" width="10%">3F</td>
|
|
<td align="left" valign="top" width="20%">CHAR(256)</td>
|
|
<td align="left" valign="top" width="60%">Returned sort sequence table</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRRSSFMT2">RSST0200 Format</a></h3>
|
|
|
|
<p>Following is the format of the information returned. For a description of
|
|
the fields in this format, see <a href="#HDRRSSFLD">Field Descriptions</a>.</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 valign="bottom" align="center">Dec</th>
|
|
<th valign="bottom" align="center">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 available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">4</td>
|
|
<td align="center" valign="TOP" width="10%">4</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" width="10%">8</td>
|
|
<td align="center" valign="TOP" width="10%">8</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Job CCSID value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">12</td>
|
|
<td align="center" valign="TOP" width="10%">C</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">CCSID of returned table</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">16</td>
|
|
<td align="center" valign="TOP" width="10%">10</td>
|
|
<td align="left" valign="top" width="20%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="60%">Substitution values encountered</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">17</td>
|
|
<td align="center" valign="TOP" width="10%">11</td>
|
|
<td align="left" valign="top" width="20%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="60%">Weighting of returned sort sequence
|
|
table</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">18</td>
|
|
<td align="center" valign="TOP" width="10%">12</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Returned table name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">28</td>
|
|
<td align="center" valign="TOP" width="10%">1C</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Returned table library name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">38</td>
|
|
<td align="center" valign="TOP" width="10%">26</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Job sort sequence table name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">48</td>
|
|
<td align="center" valign="TOP" width="10%">30</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Job sort sequence table library
|
|
name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">58</td>
|
|
<td align="center" valign="TOP" width="10%">3A</td>
|
|
<td align="left" valign="top" width="20%">CHAR(3)</td>
|
|
<td align="left" valign="top" width="60%">Job language identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">61</td>
|
|
<td align="center" valign="TOP" width="10%">3D</td>
|
|
<td align="left" valign="top" width="20%">CHAR(2)</td>
|
|
<td align="left" valign="top" width="60%">Job country or region identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">63</td>
|
|
<td align="center" valign="TOP" width="10%">3F</td>
|
|
<td align="left" valign="top" width="20%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="60%">Type of sort sequence table
|
|
returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">64</td>
|
|
<td align="center" valign="TOP" width="10%">40</td>
|
|
<td align="left" valign="top" width="20%">BIN(4)</td>
|
|
<td align="left" valign="top" width="60%">Offset to returned sort sequence
|
|
table</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%">68</td>
|
|
<td align="center" valign="TOP" width="10%">44</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Size of returned sort sequence
|
|
table</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP" width="10%"> </td>
|
|
<td align="center" valign="TOP" width="10%"> </td>
|
|
<td align="left" valign="top" width="20%">CHAR(*)</td>
|
|
<td align="left" valign="top" width="60%">Returned sort sequence table</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRRSSFLD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Bytes available.</strong> The number of bytes of information
|
|
available.</p>
|
|
|
|
<p><strong>Bytes returned.</strong> The number of bytes of information
|
|
returned.</p>
|
|
|
|
<p><strong>CCSID of returned table.</strong> The coded character set identifier
|
|
(CCSID) in which the returned sort sequence table is encoded.</p>
|
|
|
|
<p><strong>Notes:</strong></p>
|
|
|
|
<ol>
|
|
<li>No conversion is performed if the CCSID tag of the stored table is 65535 or
|
|
if the job CCSID value is used and it is 65535.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>All tables created before Version 2 Release 3 will always be assumed to be
|
|
tagged with a CCSID value of 65535.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>If *HEX is specified for the sort sequence to get, this value is set to
|
|
65535.</li>
|
|
</ol>
|
|
|
|
<p><strong>Job CCSID value.</strong> The CCSID value of this job.</p>
|
|
|
|
<p><strong>Job country or region identifier.</strong> The country or region
|
|
identifier of this job.</p>
|
|
|
|
<p><strong>Job language identifier.</strong> The language identifier of this
|
|
job.</p>
|
|
|
|
<p><strong>Job sort sequence table library name.</strong> The sort sequence
|
|
table library name of this job.</p>
|
|
|
|
<p><strong>Job sort sequence table name.</strong> The sort sequence table name
|
|
of this job. It can have one of the special values:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LANGIDUNQ</em></td>
|
|
<td align="left" valign="top">The unique-weight sort sequence table that is associated with
|
|
the language identifier requested parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LANGIDSHR</em></td>
|
|
<td align="left" valign="top">The shared-weight sort sequence table that is associated with
|
|
the language identifier requested parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*HEX</em></td>
|
|
<td align="left" valign="top">The sort sequence according to the hexadecimal value of the
|
|
characters.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Offset to returned sort sequence table.</strong> The offset in bytes
|
|
to the first element in the returned sort sequence table. A value of 0
|
|
indicates no table was returned.</p>
|
|
|
|
<p><strong>Returned table name.</strong> The name of the sort sequence table
|
|
that was returned.</p>
|
|
|
|
<p>The value of the returned table name is
|
|
"<samp>*N </samp> " if the table
|
|
returned is the result of a requested sort sequence of *HEX or the result of
|
|
converting an existing table from its stored CCSID representation to the CCSID
|
|
requested. (A new table object will not be created in this case.)</p>
|
|
|
|
<p><strong>Returned table library name.</strong> The name of the sort sequence
|
|
table library that was returned.</p>
|
|
|
|
<p>The value of the returned table library name is
|
|
"<samp>*N </samp> " if the table
|
|
returned is the result of a requested sort sequence of *HEX or the result of
|
|
converting an existing table from its stored CCSID representation to the CCSID
|
|
requested.</p>
|
|
|
|
<p>If *LIBL or *CURLIB was specified for the qualified table name, the name of
|
|
the library in which the sort sequence resides will be returned.</p>
|
|
|
|
<p><strong>Returned sort sequence table.</strong> The variable length sort
|
|
sequence table that is described by the input values. The returned UCS-2 sort
|
|
sequence table can be used as control map type E-1 for the XLATEMB instruction
|
|
by using the information that starts at offset 94 from the beginning of the
|
|
table and ends at the end of the table.</p>
|
|
|
|
<p><strong>Size of returned sort sequence table.</strong> The number of bytes
|
|
in the sort sequence table that is returned.</p>
|
|
|
|
<p><strong>Substitution values encountered.</strong> Whether substitution
|
|
values were involved during the conversion from the source CCSID of the table
|
|
to the requested CCSID. A substitution occurs when a character in the source
|
|
CCSID does not exist in the requested CCSID. The valid values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">No substitutions were involved.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Substitutions were involved.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Type of sort sequence table returned.</strong> The type of sort
|
|
sequence table returned. The valid values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Single byte sort sequence table returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">UCS-2 sort sequence table returned.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Weighting of returned sort sequence table.</strong> The weighting of
|
|
sort sequence table returned. The valid values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">A shared-weight table.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">A unique-weight table.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> Any table created prior to Version 2 Release 3 is
|
|
always returned as a shared-weight table.</p>
|
|
|
|
<br>
|
|
<h3>Layout of a Returned UCS-2 Sort Sequence Table</h3>
|
|
|
|
<p>The size of a returned sort sequence table includes 128 bytes of the header,
|
|
4 bytes containing the number of cells, and the number of cells * 4 bytes.</p>
|
|
|
|
<p>A cell has the following layout:</p>
|
|
|
|
<blockquote>
|
|
<p>2 bytes for the code point</p>
|
|
|
|
<p>2 bytes for the weight</p>
|
|
|
|
<p>The remainder of the line is ignored and can be used for comments.</p>
|
|
</blockquote>
|
|
|
|
<p><img src="RBAFX558.gif" alt="Layout of a Returned UCS-2 Sort Sequence Table"></p>
|
|
|
|
<p>The following is an example of a UCS-2 sort sequence table.</p>
|
|
|
|
<p><img src="RBAFX559.gif" alt="Example of a UCS-2 sort sequence table"></p>
|
|
|
|
<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">CPF2115 E</td>
|
|
<td align="left" valign="top">Object &1 in &2 type *&3 damaged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2169 E</td>
|
|
<td align="left" valign="top">Job's sort sequence information not available.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2207 E</td>
|
|
<td align="left" valign="top">Not authorized to use object &1 in library &3 type
|
|
*&2.</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">CPF3BC6 E</td>
|
|
<td align="left" valign="top">Sort sequence &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3BC7 E</td>
|
|
<td align="left" valign="top">CCSID &1 outside of valid range.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3BC8 E</td>
|
|
<td align="left" valign="top">Conversion from CCSID &1 to CCSID &2 is not
|
|
supported.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3BC9 E</td>
|
|
<td align="left" valign="top">Conversion from CCSID &1 to CCSID &2 is not
|
|
defined.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3BCC E</td>
|
|
<td align="left" valign="top">Language identifier &1 not valid.</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 &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">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF8100 E</td>
|
|
<td align="left" valign="top">All CPF81xx messages could be returned. xx is from 01 to
|
|
FF.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9801 E</td>
|
|
<td align="left" valign="top">Object &2 in library &3 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9802 E</td>
|
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9803 E</td>
|
|
<td align="left" valign="top">Cannot allocate object &2 in library &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9810 E</td>
|
|
<td align="left" valign="top">Library &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9820 E</td>
|
|
<td align="left" valign="top">Not authorized to use library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library &2 ended.
|
|
Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<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=
|
|
"nls1.htm">National Language Support APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|