ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/setobjacc.htm

297 lines
9.8 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">
<title>Set Object Access (SETOBJACC)</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="SETOBJACC.Top_Of_Page"></a>
<h2>Set Object Access (SETOBJACC)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#SETOBJACC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#SETOBJACC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#SETOBJACC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="SETOBJACC"></a>
<p>The Set Object Access (SETOBJACC) command temporarily changes the speed of access to an object by bringing the object into a main storage pool or purging it from all main storage pools. An object can be kept main storage resident by selecting a pool for the object that has available space and does not have jobs associated with it. Repeated use of the command can cause a set of objects to be resident in a main storage pool.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have object operational (*OBJOPR) authority to all objects that are brought into a main storage pool or purged from all main storage pools.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETOBJACC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="SETOBJACC.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" rowspan="3"><a href="#SETOBJACC.OBJ"><b>OBJ</b></a></td>
<td valign="top">Object</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Object</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *USRLIBL, *CURLIB, *ALL, *ALLUSR</td>
</tr><tr>
<td valign="top"><a href="#SETOBJACC.OBJTYPE"><b>OBJTYPE</b></a></td>
<td valign="top">Object type</td>
<td valign="top">*FILE, *PGM</td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#SETOBJACC.POOL"><b>POOL</b></a></td>
<td valign="top">Storage pool</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top">Element 1: Shared pool or subsystem name</td>
<td valign="top">
<i>Name</i>, *JOB, *BASE, *SHRPOOL1, *SHRPOOL2, *SHRPOOL3, *SHRPOOL4, *SHRPOOL5, *SHRPOOL6, *SHRPOOL7, *SHRPOOL8, *SHRPOOL9, *SHRPOOL10, *SHRPOOL11, *SHRPOOL12, *SHRPOOL13, *SHRPOOL14, *SHRPOOL15, *SHRPOOL16, *SHRPOOL17, *SHRPOOL18, *SHRPOOL19, *SHRPOOL20, *SHRPOOL21, *SHRPOOL22, *SHRPOOL23, *SHRPOOL24, *SHRPOOL25, *SHRPOOL26, *SHRPOOL27, *SHRPOOL28, *SHRPOOL29, *SHRPOOL30, *SHRPOOL31, *SHRPOOL32, *SHRPOOL33, *SHRPOOL34, *SHRPOOL35, *SHRPOOL36, *SHRPOOL37, *SHRPOOL38, *SHRPOOL39, *SHRPOOL40, *SHRPOOL41, *SHRPOOL42, *SHRPOOL43, *SHRPOOL44, *SHRPOOL45, *SHRPOOL46, *SHRPOOL47, *SHRPOOL48, *SHRPOOL49, *SHRPOOL50, *SHRPOOL51, *SHRPOOL52, *SHRPOOL53, *SHRPOOL54, *SHRPOOL55, *SHRPOOL56, *SHRPOOL57, *SHRPOOL58, *SHRPOOL59, *SHRPOOL60, *PURGE</td>
</tr>
<tr>
<td valign="top">Element 2: Pool identifier</td>
<td valign="top">
1-10</td>
</tr>
<tr>
<td valign="top"><a href="#SETOBJACC.MBR"><b>MBR</b></a></td>
<td valign="top">Member</td>
<td valign="top"><i>Name</i>, <b><u>*FIRST</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETOBJACC.MBRDATA"><b>MBRDATA</b></a></td>
<td valign="top">Member data</td>
<td valign="top"><b><u>*BOTH</u></b>, *ACCPTH, *DATA</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#SETOBJACC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="SETOBJACC.OBJ"></a>
<h3>Object (OBJ)</h3>
<p>Specifies the qualified name of the object to be brought into or deleted from main storage.
</p>
<p>The name of the specified object can be qualified by one of the following library values:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b>*USRLIBL</b></dt>
<dd>Only the libraries in the user portion of the job's library list are searched.
</dd>
<dt><b>*ALL</b></dt>
<dd>All libraries on the system are searched.
</dd>
</dl>
<dl>
<dt><b>*ALLUSR</b></dt>
<dd>All user libraries are searched. All libraries with names that do not begin with the letter Q are searched except for the following:
<p>
<pre>
#CGULIB #DSULIB #SEULIB
#COBLIB #RPGLIB
#DFULIB #SDALIB
</pre>
</p>
<p>Although the following Qxxx libraries are provided by IBM, they typically contain user data that changes frequently. Therefore, these libraries are considered user libraries and are also searched:
</p>
<p>
<pre>
QDSNX QRCLxxxxx QUSRIJS QUSRVxRxMx
QGPL QSRVAGT QUSRINFSKR
QGPL38 QSYS2 QUSRNOTES
QMGTC QSYS2xxxxx QUSROND
QMGTC2 QS36F QUSRPOSGS
QMPGDATA QUSER38 QUSRPOSSA
QMQMDATA QUSRADSM QUSRPYMSVR
QMQMPROC QUSRBRM QUSRRDARS
QPFRDATA QUSRDIRCL QUSRSYS
QRCL QUSRDIRDB QUSRVI
</pre>
</p>
<ol>
<li>'xxxxx' is the number of a primary auxiliary storage pool (ASP).
</li>
<li>A different library name, in the format QUSRVxRxMx, can be created by the user for each previous release supported by IBM to contain any user commands to be compiled in a CL program for the previous release. For the QUSRVxRxMx user library, VxRxMx is the version, release, and modification level of a previous release that IBM continues to support.
</li>
</ol>
</dd>
</dl>
<dl>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
<p>The possible values are:
</p>
<dl>
<dt><b><i>object-name</i></b></dt>
<dd>Specify the name of the object.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETOBJACC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETOBJACC.OBJTYPE"></a>
<h3>Object type (OBJTYPE)</h3>
<p>Specifies the type of object to be brought into or deleted from main storage.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*FILE</b></dt>
<dd>The object is a file.
</dd>
<dt><b>*PGM</b></dt>
<dd>The object is a program.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETOBJACC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETOBJACC.POOL"></a>
<h3>Storage pool (POOL)</h3>
<p>Specifies whether the object is brought into or purged from main storage.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*JOB</b></dt>
<dd>The object is brought into the pool associated with the job.
</dd>
<dt><b>*BASE</b></dt>
<dd>The object is brought into the base pool.
</dd>
<dt><b>*SHRPOOLn</b></dt>
<dd>The object is brought into a a general-purpose shared pool. Valid values range from 1 through 10.
</dd>
<dt><b>*PURGE</b></dt>
<dd>The object is purged from all pools. <b>Element 1: Subsystem</b>
</dd>
<dt><b><i>subsystem</i></b></dt>
<dd>Specify a subsystem name. <b>Element 2: Pool Identifier</b>
</dd>
<dt><b><i>pool-identifier</i></b></dt>
<dd>Specify a subsystem pool identifier.
</dd>
<dt><b>*PURGE</b></dt>
<dd>The object is purged from all pools.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETOBJACC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETOBJACC.MBR"></a>
<h3>Member (MBR)</h3>
<p>Specifies the database file member to be brought into or purged from main storage.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member is selected.
</dd>
<dt><b><i>file-member-name</i></b></dt>
<dd>Specify the member name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETOBJACC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETOBJACC.MBRDATA"></a>
<h3>Member data (MBRDATA)</h3>
<p>Specifies the member data to be brought into or purged from main storage.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*BOTH</u></b></dt>
<dd>All parts of the object are selected.
</dd>
<dt><b>*ACCPTH</b></dt>
<dd>The file member's access path is selected.
</dd>
<dt><b>*DATA</b></dt>
<dd>The file member's data is selected.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETOBJACC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="SETOBJACC.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
SETOBJACC OBJ(OBJA) OBJTYPE(*PGM) POOL(*JOB)
</pre>
</p>
<p>This command brings a program named OBJA to the pool associated with the job in which the command is run.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETOBJACC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="SETOBJACC.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF1858</b></dt>
<dd>The specified pool does not exist.
</dd>
<dt><b>CPF1859</b></dt>
<dd>Use of an access path was requested but none exists.
</dd>
<dt><b>CPF9855</b></dt>
<dd>File &amp;1 in library &amp;3 contains no members.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETOBJACC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>