193 lines
6.5 KiB
HTML
193 lines
6.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">
|
||
|
<title>Retrieve Image Catalog (RTVIMGCLG)</title>
|
||
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
</head>
|
||
|
<body bgcolor="white">
|
||
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
<a name="RTVIMGCLG.Top_Of_Page"></a>
|
||
|
<h2>Retrieve Image Catalog (RTVIMGCLG)</h2>
|
||
|
<table width="100%">
|
||
|
<tr>
|
||
|
<td valign="top" align="left"><b>Where allowed to run: </b>Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX)<br>
|
||
|
<b>Threadsafe: </b>No
|
||
|
</td>
|
||
|
<td valign="top" align="right">
|
||
|
<a href="#RTVIMGCLG.PARAMETERS.TABLE">Parameters</a><br>
|
||
|
<a href="#RTVIMGCLG.COMMAND.EXAMPLES">Examples</a><br>
|
||
|
<a href="#RTVIMGCLG.ERROR.MESSAGES">Error messages</a></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
|
||
|
<div> <a name="RTVIMGCLG"></a>
|
||
|
<p>The Retrieve Image Catalog (RTVIMGCLG) command is used in a CL procedure to retrieve the name of the image catalog loaded in a virtual device, or to retrieve the name of the virtual device an image catalog is loaded in.
|
||
|
</p>
|
||
|
<p><b>Restrictions:</b>
|
||
|
</p>
|
||
|
<ul>
|
||
|
<li>This command is shipped with public *EXCLUDE authority.
|
||
|
</li>
|
||
|
<li>The following authorities are required to retrieve the name of the virtual device an image catalog is loaded in:
|
||
|
<ol>
|
||
|
<li>Execute (*EXECUTE) authority to library QUSRSYS.
|
||
|
</li>
|
||
|
<li>*USE authority to the image catalog.
|
||
|
</li>
|
||
|
</ol>
|
||
|
</li>
|
||
|
<li>The following authorities are required to retrieve the name of the image catalog loaded in a virtual device:
|
||
|
<ol>
|
||
|
<li>*USE authority to the device.
|
||
|
</li>
|
||
|
</ol>
|
||
|
</li>
|
||
|
<li>This command is valid only in a compiled CL procedure.
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<table width="100%">
|
||
|
<tr><td align="right"><a href="#RTVIMGCLG.Top_Of_Page">Top</a></td></tr>
|
||
|
</table>
|
||
|
<hr size="2" width="100%">
|
||
|
|
||
|
<div>
|
||
|
<h3><a name="RTVIMGCLG.PARAMETERS.TABLE">Parameters</a></h3>
|
||
|
<table border="1" cellpadding="4" cellspacing="0">
|
||
|
<!-- col1="10" col2="15" col3="30" col4="10" -->
|
||
|
<tr>
|
||
|
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
|
||
|
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
|
||
|
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
|
||
|
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td valign="top"><a href="#RTVIMGCLG.IMGCLG"><b>IMGCLG</b></a></td>
|
||
|
<td valign="top">Image catalog</td>
|
||
|
<td valign="top"><i>Name</i></td>
|
||
|
<td valign="top">Optional</td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td valign="top"><a href="#RTVIMGCLG.DEV"><b>DEV</b></a></td>
|
||
|
<td valign="top">Virtual device</td>
|
||
|
<td valign="top"><i>Name</i></td>
|
||
|
<td valign="top">Optional</td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td valign="top"><a href="#RTVIMGCLG.DEVLOD"><b>DEVLOD</b></a></td>
|
||
|
<td valign="top">CL var for DEVLOD (10)</td>
|
||
|
<td valign="top"><i>Character value</i></td>
|
||
|
<td valign="top">Optional</td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td valign="top"><a href="#RTVIMGCLG.IMGCLGLOD"><b>IMGCLGLOD</b></a></td>
|
||
|
<td valign="top">CL var for IMGCLGLOD (10)</td>
|
||
|
<td valign="top"><i>Character value</i></td>
|
||
|
<td valign="top">Optional</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
|
||
|
<table width="100%">
|
||
|
<tr><td align="right"><a href="#RTVIMGCLG.Top_Of_Page">Top</a></td></tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div> <a name="RTVIMGCLG.IMGCLG"></a>
|
||
|
<h3>Image catalog (IMGCLG)</h3>
|
||
|
<p>Specifies the image catalog whose associated virtual device name is to be retrieved.
|
||
|
</p>
|
||
|
<p>
|
||
|
<b>Note: </b>A value must be specified for this parameter or the <b>Virtual device (DEV)</b> parameter.
|
||
|
</p>
|
||
|
<dl>
|
||
|
<dt><b><i>name</i></b></dt>
|
||
|
<dd>Specify the name of the image catalog.
|
||
|
</dd>
|
||
|
</dl>
|
||
|
</div>
|
||
|
<table width="100%">
|
||
|
<tr><td align="right"><a href="#RTVIMGCLG.Top_Of_Page">Top</a></td></tr>
|
||
|
</table>
|
||
|
<div> <a name="RTVIMGCLG.DEV"></a>
|
||
|
<h3>Virtual device (DEV)</h3>
|
||
|
<p>Specify the virtual device whose associated image catalog name is to be retrieved.
|
||
|
</p>
|
||
|
<p>
|
||
|
<b>Note: </b>A value must be specified for this parameter or the <b>Image catalog (IMGCLG)</b> parameter.
|
||
|
</p>
|
||
|
<dl>
|
||
|
<dt><b><i>name</i></b></dt>
|
||
|
<dd>Specify the name of the virtual device.
|
||
|
</dd>
|
||
|
</dl>
|
||
|
</div>
|
||
|
<table width="100%">
|
||
|
<tr><td align="right"><a href="#RTVIMGCLG.Top_Of_Page">Top</a></td></tr>
|
||
|
</table>
|
||
|
<div> <a name="RTVIMGCLG.DEVLOD"></a>
|
||
|
<h3>CL var for DEVLOD (10) (DEVLOD)</h3>
|
||
|
<p>Specifies the name of the CL variable that receives the name of the current virtual device for which the specified image catalog is loaded. You must specify a CL variable declared as TYPE(*CHAR) with a minimum length of 10 characters. A value of *NONE will be returned if the name specified for the <b>Image catalog (IMGCLG)</b> parameter is not associated with a virtual device.
|
||
|
</p>
|
||
|
</div>
|
||
|
<table width="100%">
|
||
|
<tr><td align="right"><a href="#RTVIMGCLG.Top_Of_Page">Top</a></td></tr>
|
||
|
</table>
|
||
|
<div> <a name="RTVIMGCLG.IMGCLGLOD"></a>
|
||
|
<h3>CL var for IMGCLGLOD (10) (IMGCLGLOD)</h3>
|
||
|
<p>Specifies the name of the CL variable that receives the name of the image catalog currently loaded for the specified virtual device. You must specify a CL variable declared as TYPE(*CHAR) with a minimum length of 10 characters. A value of *NONE will be returned if the name specified for the <b>Virtual device (DEV)</b> parameter is not associated with an image catalog.
|
||
|
</p>
|
||
|
</div>
|
||
|
<table width="100%">
|
||
|
<tr><td align="right"><a href="#RTVIMGCLG.Top_Of_Page">Top</a></td></tr>
|
||
|
</table>
|
||
|
<hr size="2" width="100%">
|
||
|
<div><h3><a name="RTVIMGCLG.COMMAND.EXAMPLES">Examples</a> </h3>
|
||
|
<p><b>Example 1: Retrieving the Loaded Virtual Device Name</b>
|
||
|
</p>
|
||
|
<p>
|
||
|
<pre>
|
||
|
DCL VAR(&MYLODDEV) TYPE(*CHAR) LEN(10)
|
||
|
RTVIMGCLG IMGCLG(MYCLG) DEVLOD(&MYLODDEV)
|
||
|
</pre>
|
||
|
</p>
|
||
|
<p>This command will retrieve the name of the loaded virtual device associated with image catalog <b>MYCLG</b>.
|
||
|
</p>
|
||
|
<p><b>Example 2: Retrieving the Image Catalog Loaded in a Virtual Device</b>
|
||
|
</p>
|
||
|
<p>
|
||
|
<pre>
|
||
|
DCL VAR(&MYCLGLOD) TYPE(*CHAR) LEN(10)
|
||
|
RTVIMGCLG DEV(OPTVRT01) IMGCLGLOD(&MYCLGLOD)
|
||
|
</pre>
|
||
|
</p>
|
||
|
<p>This command will retrieve the name of the image catalog associated with virtual device <b>OPTVRT01</b>.
|
||
|
</p>
|
||
|
</div>
|
||
|
<table width="100%">
|
||
|
<tr><td align="right"><a href="#RTVIMGCLG.Top_Of_Page">Top</a></td></tr>
|
||
|
</table>
|
||
|
<hr size="2" width="100%">
|
||
|
<div><h3><a name="RTVIMGCLG.ERROR.MESSAGES">Error messages</a> </h3>
|
||
|
<p><b><u>*ESCAPE Messages</u></b>
|
||
|
</p>
|
||
|
<dl>
|
||
|
<dt><b>CPFBC45</b></dt>
|
||
|
<dd>Image catalog &1 not found.
|
||
|
</dd>
|
||
|
<dt><b>CPF9802</b></dt>
|
||
|
<dd>Not authorized to object &2 in &3.
|
||
|
</dd>
|
||
|
<dt><b>CPF9820</b></dt>
|
||
|
<dd>Not authorized to use library &1.
|
||
|
</dd>
|
||
|
<dt><b>CPF9825</b></dt>
|
||
|
<dd>Not authorized to device &1.
|
||
|
</dd>
|
||
|
</dl>
|
||
|
</div>
|
||
|
<table width="100%">
|
||
|
<tr><td align="right"><a href="#RTVIMGCLG.Top_Of_Page">Top</a></td></tr>
|
||
|
</table>
|
||
|
</body>
|
||
|
</html>
|