ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qlicvttp.htm

242 lines
7.0 KiB
HTML
Raw Normal View History

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>Convert Type (QLICVTTP) 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. -->
<!-- QLICVTTP SCRIPT A converted by B2H R4.1 (346) (CMS) by PMHALL at -->
<!-- RCHVMW2 on 7 Oct 1998 at 22:46:50 -->
<!-- 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>Convert Type (QLICVTTP) API</h2>
<div class="box" style="width: 70%;">
<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%">Conversion</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">Symbolic object type</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Hexadecimal object type</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(2)</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Convert Type (QLICVTTP) API lets you convert an object type from the
external symbolic format to the internal hexadecimal format and vice versa.</p>
<p>You can use the QLICVTTP API to:</p>
<br>
<ul>
<li>Convert a specific symbolic object type to an equivalent hexadecimal object
type</li>
<li>Convert a specific hexadecimal object type to an equivalent symbolic object
type</li>
</ul>
<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>
<br>
<dl>
<dt><strong>Conversion</strong></dt>
<dd>INPUT; CHAR(10)
<p>The type of conversion to perform.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*HEXTOSYM</em></td>
<td align="left" valign="top">An object type in hexadecimal form is converted
to an equivalent symbolic object type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYMTOHEX</em></td>
<td align="left" valign="top">A symbolic object type is converted to an
equivalent hexadecimal form.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Symbolic object type</strong></dt>
<dd>I/O; CHAR(10)
<p>The external symbolic name given to an object type. An asterisk (*) precedes
the object type. The value of the conversion parameter specified determines if
this is an input or output field. For a complete list of the available external
object types, see <a href="../rbam6/rbam6objecttypes.htm">External object types</a>
in the Control Language (CL) topic.</p>
<p>As an example, if the value of the
Conversion field is '*SYMTOHEX' and the
value of the Symbolic object type field is '*LIB', a value of x'0401' is
returned in the Hexadecimal object type field. If the value of the conversion field
is '*HEXTOSYM' and the value of the Hexadecimal object type field is
x'0401', a value of '*LIB' is returned in the Symbolic object type field.
</p>
</dd>
<dt><strong>Hexadecimal object type</strong></dt>
<dd>I/O; CHAR(2)
<p>The MI representation of an external object type. This field is in
hexadecimal form. The value of the conversion specified determines if this is
an input or output field. For a list of the hexadecimal formats associated with
external object types, see <a href="../rbam6/rbam6objecttypes.htm">External object types</a>
in the Control Language (CL) topic.</p>
<p>As an example, if the value of the
Conversion field is '*SYMTOHEX' and the
value of the Symbolic object type field is '*DTAARA', a value of x'190A'
is returned in the Hexadecimal object type field. If the value of the conversion
field is '*HEXTOSYM' and the value of the Hexadecimal object type field is
x'190A', a value of '*DTAARA' is returned in the Symbolic object type field.
</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>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">CPF2101 E</td>
<td align="left" valign="top">Object type *&amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2102 E</td>
<td align="left" valign="top">Object type and subtype code &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF219C E</td>
<td align="left" valign="top">Conversion value &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF219D E</td>
<td align="left" valign="top">Object type &amp;1 not valid external object
type.</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">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">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>
<hr>
API introduced: V2R2
<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=
"obj1.htm">Object APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>