998 lines
29 KiB
HTML
998 lines
29 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 Lock Space Locks (QTRXRLSL) 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. -->
|
||
|
|
<!-- Created for V5R2 -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- 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 Lock Space Locks (QTRXRLSL) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<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 of receiver information</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">Lock space identifier</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(20)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Lock filters</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">Format of lock filters</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 Lock Space Locks (QTRXRLSL) API generates a list of objects
|
||
|
|
that have been locked or that have lower level locks held by the specified lock
|
||
|
|
space. Locks that are being waited for on behalf of a lock space are not returned.
|
||
|
|
Use the Retrieve Job Locks (QWCRJBLK) or Retrieve Lock Information (QWCRLCKI) API
|
||
|
|
to retrieve locks that are being waited for by a thread on behalf of a lock space.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Job Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>The caller of the API must be running under a user profile that has job
|
||
|
|
control (*JOBCTL) special authority.</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 as long as
|
||
|
|
you specify the length parameter correctly. As a result, the API returns only
|
||
|
|
the data that the area can hold. For example, this may mean that the number of
|
||
|
|
locked object entries available in the receiver variable do not match the value
|
||
|
|
in the number of locked object entries returned.</p>
|
||
|
|
|
||
|
|
<p>See <a href="#HDRRCVF">Format of Receiver Information</a> for details on the
|
||
|
|
format of the receiver information.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the receiver variable provided. The length of the receiver
|
||
|
|
variable parameter may be specified up to the size of the receiver variable
|
||
|
|
specified in the user program. If the length of the receiver variable specified
|
||
|
|
is larger then the allocated size of the receiver variable specified in the
|
||
|
|
user program, the results are not predictable. The minimum length is 8
|
||
|
|
bytes.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format of receiver information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the information returned in the receiver variable. The
|
||
|
|
format name is:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>RLSL0100</em></td>
|
||
|
|
<td align="left" valign="top">The object and member lock format. See <a href="#RLSL0100">
|
||
|
|
RLSL0100 Format</a> for details on the list of objects and members that this
|
||
|
|
lock space has locked.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Lock space identifier</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(20)
|
||
|
|
|
||
|
|
<p>The identifier of the lock space for which record locks are to be
|
||
|
|
returned.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Lock filters</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT;CHAR(*)
|
||
|
|
|
||
|
|
<p>Filters used for the lock information that is returned. See <a href=
|
||
|
|
"#lockfilters">Format of lock filters</a> for further information.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format of lock filters</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the lock filters used on the returned data. The format name is:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>RLSF0100</em></td>
|
||
|
|
<td align="left" valign="top">Lock filter format. See <a href="#RLSF0100">
|
||
|
|
RLSF0100 Format</a> for details on the filters contained in this format.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</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="HDRRCVF">Format of receiver information</a></h3>
|
||
|
|
|
||
|
|
<p>The format of the information returned in the receiver variable.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="RLSL0100">RLSL0100 Format</a></h3>
|
||
|
|
|
||
|
|
<p>This format is used to return objects and members that are locked. For
|
||
|
|
detailed descriptions of the fields in the table, see <a href="#RLSL0100fd">
|
||
|
|
Field Descriptions</a> for RLSL0100 Format.</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 align="center" valign="bottom">Dec</th>
|
||
|
|
<th align="center" valign="bottom">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 returned</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 available</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 locked object entries available</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 list of locked objects</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="center" valign="top">C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of locked object entries returned</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="center" valign="top">14</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of locked object entry</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<p>Each locked object returned will have the following structure.</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 align="center" valign="bottom">Dec</th>
|
||
|
|
<th align="center" valign="bottom">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%">Type of entity</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">CHAR(30)</td>
|
||
|
|
<td align="left" valign="top">Extended object name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">34</td>
|
||
|
|
<td align="center" valign="top">22</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Object library name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">44</td>
|
||
|
|
<td align="center" valign="top">2C</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Object ASP name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">54</td>
|
||
|
|
<td align="center" valign="top">36</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Object library ASP name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">64</td>
|
||
|
|
<td align="center" valign="top">40</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Object ASP number</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">68</td>
|
||
|
|
<td align="center" valign="top">44</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Object library ASP number</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">72</td>
|
||
|
|
<td align="center" valign="top">48</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Object type</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">82</td>
|
||
|
|
<td align="center" valign="top">52</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Extended object attributes</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">92</td>
|
||
|
|
<td align="center" valign="top">5C</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Member name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">102</td>
|
||
|
|
<td align="center" valign="top">66</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Member lock type</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">103</td>
|
||
|
|
<td align="center" valign="top">67</td>
|
||
|
|
<td align="left" valign="top">CHAR(3)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">106</td>
|
||
|
|
<td align="center" valign="top">6A</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Lock state</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">116</td>
|
||
|
|
<td align="center" valign="top">74</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Lock status</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">120</td>
|
||
|
|
<td align="center" valign="top">78</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Member locks</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">124</td>
|
||
|
|
<td align="center" valign="top">7C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Lock count</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">128</td>
|
||
|
|
<td align="center" valign="top">80</td>
|
||
|
|
<td align="left" valign="top">CHAR(64)</td>
|
||
|
|
<td align="left" valign="top">Object lock handle</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">192</td>
|
||
|
|
<td align="center" valign="top">C0</td>
|
||
|
|
<td align="left" valign="top">CHAR(64)</td>
|
||
|
|
<td align="left" valign="top">Lock request handle</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="RLSL0100fd">Field Descriptions for RLSL0100 Format</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Bytes available.</strong> The number of bytes of data available to
|
||
|
|
be returned. All available data is returned if enough space is provided.</p>
|
||
|
|
|
||
|
|
<p><strong>Bytes returned.</strong> The number of bytes of data returned. Only
|
||
|
|
complete entries are returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Extended object attributes.</strong> The extended attributes of an
|
||
|
|
object. Extended attributes further describe the object. For example, an object
|
||
|
|
type of *PGM may have a value of RPG (RPG program) or CLP (CL program). This
|
||
|
|
field will be blank if there is no extended attribute associated with the
|
||
|
|
object type.</p>
|
||
|
|
|
||
|
|
<p><strong>Extended object name.</strong> The name of the object that is
|
||
|
|
locked. If the lock is on a database member, the object name is the name of the
|
||
|
|
file that owns the member to which the lock applies. If the member lock type is
|
||
|
|
member or access path, the file that owns the member may be either a physical
|
||
|
|
file or a logical file. If the member lock type is data, the file that owns the
|
||
|
|
member is a physical file. The following special value also may be
|
||
|
|
returned:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*N</em></td>
|
||
|
|
<td align="left" valign="top">The name of the object cannot be determined.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Length of locked object entry.</strong> The length of each locked
|
||
|
|
object entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Lock count.</strong> The number of identical locks on this
|
||
|
|
entity.</p>
|
||
|
|
|
||
|
|
<p><strong>Lock request handle</strong>. A handle to lock request information.
|
||
|
|
Using the Retrieve Lock Request Information (QWCRLRQI) API and passing in this
|
||
|
|
handle, you can retrieve additional information about the program that
|
||
|
|
requested this lock. A value of hexadecimal zero is returned when additional
|
||
|
|
information cannot be retrieved. This value is a temporary value that can
|
||
|
|
expire. See the <a href="qwcrlrqi.htm">Retrieve Lock Request Information</a>
|
||
|
|
(QWCRLRQI) API for additional information.</p>
|
||
|
|
|
||
|
|
<p><strong>Lock state.</strong> The lock condition for the lock request. Lower
|
||
|
|
level locks are returned and can occur when a member of a file is locked, but
|
||
|
|
the file itself is not locked. Possible other values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>Blank</em></td>
|
||
|
|
<td align="left" valign="top">The object is not locked, but there are locks on
|
||
|
|
lower level objects.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SHRRD</em></td>
|
||
|
|
<td align="left" valign="top">Lock shared for read.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SHRUPD</em></td>
|
||
|
|
<td align="left" valign="top">Lock shared for update.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SHRNUP</em></td>
|
||
|
|
<td align="left" valign="top">Lock shared, no update.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*EXCLRD</em></td>
|
||
|
|
<td align="left" valign="top">Lock exclusive, read allowed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*EXCL</em></td>
|
||
|
|
<td align="left" valign="top">Lock exclusive, no read allowed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Lock status.</strong> The status of the lock request. Possible
|
||
|
|
values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The object is not locked, but there are locks on
|
||
|
|
lower level objects.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The lock on this object currently is held by the
|
||
|
|
lock space.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Member locks.</strong> The number of member locks for a database
|
||
|
|
file. If the object is not a database file, 0 is returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Member lock type.</strong> If the lock is on a member, this field
|
||
|
|
indicates the type of member lock; otherwise, it is blank. Possible values
|
||
|
|
are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>Blank</em></td>
|
||
|
|
<td align="left" valign="top">The object type is not a member.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The lock is a member lock.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The lock is a data lock.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">The lock is an access path lock.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Member name.</strong> The name of the member that has a lock held or
|
||
|
|
waiting on it. If the type of entity is not a member object, this field is
|
||
|
|
blank. The following special value also may be returned:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*N</em></td>
|
||
|
|
<td align="left" valign="top">The name of the object cannot be determined.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Number of locked object entries available.</strong> The number of
|
||
|
|
locked object entries that are held by this lock space.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of locked object entries returned.</strong> The number of
|
||
|
|
locked object entries that are returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Object ASP name.</strong> The name of the auxiliary sptorage pool
|
||
|
|
(ASP) that contains the object that is locked. The following special values
|
||
|
|
also may be returned:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SYSBAS</em></td>
|
||
|
|
<td align="left" valign="top">The object is located in the system ASP or a
|
||
|
|
basic user ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*N</em></td>
|
||
|
|
<td align="left" valign="top">The name of the ASP device cannot be
|
||
|
|
determined.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Object ASP number.</strong> The numeric identifier of the ASP
|
||
|
|
containing the locked object. The following values may be returned:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The object is located in the system ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2-32</em></td>
|
||
|
|
<td align="left" valign="top">The object is located in a basic user ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>33-255</em></td>
|
||
|
|
<td align="left" valign="top">The object is located in an independent ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>-1</em></td>
|
||
|
|
<td align="left" valign="top">The ASP number cannot be determined.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Object library ASP name.</strong> The name of the ASP containing the
|
||
|
|
library of the locked object. The following specials value also may be
|
||
|
|
returned:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SYSBAS</em></td>
|
||
|
|
<td align="left" valign="top">The object's library is located in the system ASP
|
||
|
|
or a basic user ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*N</em></td>
|
||
|
|
<td align="left" valign="top">The name of the ASP device cannot be
|
||
|
|
determined.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Object library ASP number.</strong> The numeric identifier of the
|
||
|
|
ASP containing the library of the locked object. The following values may be
|
||
|
|
returned:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The library is located in the system ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2-32</em></td>
|
||
|
|
<td align="left" valign="top">The library is located in a basic user ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>33-255</em></td>
|
||
|
|
<td align="left" valign="top">The library is located in an independent
|
||
|
|
ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>-1</em></td>
|
||
|
|
<td align="left" valign="top">The ASP number cannot be determined.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Object library name.</strong> The name of the library containing the
|
||
|
|
locked object. This field will be blank if the type of entity is an internal
|
||
|
|
system object or is an internal system object space location. The following
|
||
|
|
special value also may be returned:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*N</em></td>
|
||
|
|
<td align="left" valign="top">The name of the library cannot be
|
||
|
|
determined.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Object lock handle.</strong> An identifier that can be input to
|
||
|
|
Retrieve Lock Information (QWCRLCKI) API to find additional information about
|
||
|
|
other holders of locks on this object. A value of hexadecimal zero is returned
|
||
|
|
when additional information cannot be retrieved. The object lock handle is a
|
||
|
|
temporary value that can expire. See the QWCRLCKI API for additional
|
||
|
|
information.</p>
|
||
|
|
|
||
|
|
<p><strong>Object type.</strong> The object type. For a list of all the
|
||
|
|
available external i5/OS object types, see the <a href="../rbam6/rbam6clmain.htm">
|
||
|
|
Control Language (CL)</a> topic. <!-- For a list of all internal system object
|
||
|
|
types, see the OS/400 Diagnostic Aids. --></p>
|
||
|
|
|
||
|
|
<p><strong>Offset to list of locked objects.</strong> The offset in bytes from
|
||
|
|
the beginning of the receiver variable to the first entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> An unused field.</p>
|
||
|
|
|
||
|
|
<p><strong>Type of entity.</strong> A value that identifies the type of entity
|
||
|
|
for which the lock information is returned. The following values may be
|
||
|
|
returned:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">i5/OS external object</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">Member object</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>3</em></td>
|
||
|
|
<td align="left" valign="top">Internal system object</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h3><a name="lockfilters"></a>Format of lock filters</h3>
|
||
|
|
|
||
|
|
<p>The format of the lock filters used on the returned lock information.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="RLSF0100">RLSF0100 Format</a></h3>
|
||
|
|
|
||
|
|
<p>The following information is to be specified for the RLSF0100 format. For
|
||
|
|
detailed descriptions of the fields in the table, see <a href="#RLSF0100fd">
|
||
|
|
Field Descriptions</a> for RLSF0100 Format.</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 align="center" valign="bottom">Dec</th>
|
||
|
|
<th align="center" valign="bottom">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%">Filter size</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">Filter lock state</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Include i5/OS external objects flag</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">9</td>
|
||
|
|
<td align="center" valign="top">9</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Include member objects flag</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">10</td>
|
||
|
|
<td align="center" valign="top">A</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Include internal system objects flag</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">11</td>
|
||
|
|
<td align="center" valign="top">B</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Include lock space objects flag</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="center" valign="top">C</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Include unknown entities flag</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">13</td>
|
||
|
|
<td align="center" valign="top">D</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">14</td>
|
||
|
|
<td align="center" valign="top">E</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Filter object name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">24</td>
|
||
|
|
<td align="center" valign="top">18</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Filter object library name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">34</td>
|
||
|
|
<td align="center" valign="top">22</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Filter object library ASP name</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="RLSF0100fd"></a>Field Descriptions for RLSF0100 Format</h3>
|
||
|
|
|
||
|
|
<p><strong>Filter lock state.</strong> Filters information that is returned so
|
||
|
|
that it only contains information about locks that have a certain lock state.
|
||
|
|
The default is do not filter on lock state value.</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Do not filter on lock state value.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Return only the shared locks.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">Return only the exclusive locks.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Filter object library ASP name.</strong> The name of the library's
|
||
|
|
auxiliary storage pool (ASP) on which to filter. A special value of *SYSBAS can
|
||
|
|
be specified. A blank field will cause no filtering to be done on this field.
|
||
|
|
The default is to not filter on this field.</p>
|
||
|
|
|
||
|
|
<p><strong>Filter object library name.</strong> This is the library name on
|
||
|
|
which to filter. A blank field will cause no filtering to be done on this
|
||
|
|
field. The default is to not filter on this field.</p>
|
||
|
|
|
||
|
|
<p><strong>Filter object name.</strong> Only locks on the specified object are
|
||
|
|
returned. In the case of database files, members of the file also may be
|
||
|
|
returned. A blank field will cause no filtering to be done on this field. The
|
||
|
|
default is to not filter on this field.</p>
|
||
|
|
|
||
|
|
<p><strong>Filter size.</strong> The size of the filter information passed.
|
||
|
|
Valid values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>4</em></td>
|
||
|
|
<td align="left" valign="top">No filtering will be performed. The default
|
||
|
|
values will be used for each filter.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>44</em></td>
|
||
|
|
<td align="left" valign="top">All filters will be required.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Include internal system objects flag.</strong> A value of 1 in this
|
||
|
|
field allows internal system object locks to be returned. A value of 0 causes
|
||
|
|
these values to be excluded from the return data. The default is to exclude
|
||
|
|
internal system objects.</p>
|
||
|
|
|
||
|
|
<p><strong>Include lock space objects flag.</strong> A value of 1 in this field
|
||
|
|
allows lock space objects locks to be returned. A value of 0 causes these
|
||
|
|
values to be excluded from the return data. The default is to include lock
|
||
|
|
space objects.</p>
|
||
|
|
|
||
|
|
<p><strong>Include member objects flag.</strong> A value of 1 in this field
|
||
|
|
allows member objects locks to be returned. A value of 0 causes these values to
|
||
|
|
be excluded from the return data. The default is to include member objects.</p>
|
||
|
|
|
||
|
|
<p><strong>Include i5/OS external objects flag.</strong> A value of 1 in this
|
||
|
|
field allows i5/OS external object locks to be returned. A value of 0 causes
|
||
|
|
these objects to be excluded from the return data. The default is to include
|
||
|
|
i5/OS external objects.</p>
|
||
|
|
|
||
|
|
<p><strong>Include unknown types flag.</strong> A value of 1 in this field
|
||
|
|
allows locks that are of an unknown entity type to be returned. A value of 0
|
||
|
|
causes these values to be excluded from the return data. The default is to
|
||
|
|
exclude unknown types.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> An unused field.</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" width="15%">CPF24B4 E</td>
|
||
|
|
<td align="left" valign="top" width="85%">Severe error while addressing
|
||
|
|
parameter list.</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">CPF3C36 E</td>
|
||
|
|
<td align="left" valign="top">Number of parameters, &1, entered for this
|
||
|
|
API was not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C3B E</td>
|
||
|
|
<td align="left" valign="top">Value for parameter &2 for API &1 not
|
||
|
|
valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C3C E</td>
|
||
|
|
<td align="left" valign="top">Value for parameter &1 not valid.</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">CPF3CF2 E</td>
|
||
|
|
<td align="left" valign="top">Error(s) occurred during running of &1
|
||
|
|
API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFBDD1 E</td>
|
||
|
|
<td align="left" valign="top">Lock space &1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFBDD2 E</td>
|
||
|
|
<td align="left" valign="top">No authority to lock space &1.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R2
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"wm1.htm">Work Management APIs</a> | <a href="aplist.htm"> APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|