279 lines
8.5 KiB
HTML
279 lines
8.5 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 Language IDs (QLGRTVLI) 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 Language IDs (QLGRTVLI) API</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<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">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">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
Default Public Authority: *EXCLUDE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Retrieve Language Identifiers (QLGRTVLI) API retrieves a list of language identifiers and their descriptions.</p>
|
|
|
|
<br>
|
|
<!-- 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>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>Format name</strong></dt>
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The content and format of the information returned. The possible format names are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>RTVL0100</em></td>
|
|
<td valign="top">Basic language identifier format</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>See <a href="#HDRRLIFMT">RTVL0100 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="HDRRLIFMT">RTVL0100 Format</a></h3>
|
|
|
|
<p>Following is the format of the information returned. For a description of the fields in this format, see <a href="#HDRRLIFLD">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">4</td>
|
|
<td align="center" valign="TOP">4</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Bytes returned</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 language identifiers retrieved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP">12</td>
|
|
<td align="center" valign="TOP">B</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">CCSID value of descriptive text</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">Offset to start of language identifier array</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" colspan="4"><strong>Note: </strong>Format of language identifier array. The following fields are repeated for each language identifier entry.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP">0</td>
|
|
<td align="center" valign="TOP">0</td>
|
|
<td align="left" valign="top">Char(3)</td>
|
|
<td align="left" valign="top">Language Identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="TOP">3</td>
|
|
<td align="center" valign="TOP">3</td>
|
|
<td align="left" valign="top">Char(40)</td>
|
|
<td align="left" valign="top">Descriptive text</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br><br>
|
|
<h3><a name="HDRRLIFLD">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 value of descriptive text.</strong> The coded character set identifier (CCSID) that all the descriptive texts are encoded in.</p>
|
|
|
|
<p><strong>Descriptive text.</strong> The 40-character descriptive text associated with the language identifier.</p>
|
|
|
|
<p><strong>Language identifier.</strong> The 3-character language identifier.</p>
|
|
|
|
<p><strong>Number of language identifiers retrieved.</strong> The number of language identifiers in the list.</p>
|
|
|
|
<p><strong>Offset to start of language identifier array.</strong> The offset to the start of the language identifier array.</p>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<br>
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C19 E</td>
|
|
<td valign="top">Error occurred with receiver variable specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C24 E</td>
|
|
<td valign="top">Length of the receiver variable is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td 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>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|