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

179 lines
5.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>Close Database File Exit Program</title>
<!-- 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. -->
<!-- Begin Header Records --><!-- Created for V5R1 -->
<!-- File Edited March 2001 -->
<!-- This file has undergone html cleanup on 1/8/02 by JET -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--Java sync-link-->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2>Close Database File Exit Program</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%">Database close exit information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Exit Point Name: QIBM_QDB_CLOSE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Exit Point Format Name: DBCL0100<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Close Database File exit program is called when a job is trying to lock a
file that is currently held by another job due to existence of pseudo closed
cursors. If the file is no longer being used, locks are being held over the
file to improve the performance of the next SQL open in the job.
The locks can be freed to allow the requesting job to use the file.</p>
<p>After a pseudo closed SQL cursor is fully closed, if an exit program is
registered to this exit point, database will call the registered exit program
in the job that had held the lock. The intent is that the job that had
previously held the lock can now free up any additional resources it may
have been holding related to the SQL cursor.</p>
<p>For information about adding an exit program to an exit point, see the <a
href="reg1.htm">Registration Facility APIs</a>.</p>
<p><strong>Note:</strong> The Close database file exit point ignores any return
codes or error messages that are sent from the exit program.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Profile Authority</em></dt>
<dd>*ALLOBJ and *SECADM to add or remove exit programs to the registration
facility</dd>
</dl>
<br>
<h3>Required Parameter</h3>
<dl>
<dt><strong>Database close information</strong></dt>
<dd>Input; CHAR(*)
<p>Information needed by the exit program for the database file to close.</p>
</dd>
</dl>
<br>
<h3>Format of Database Close Exit Information</h3>
<p>The following table shows the structure of the close database exit
information for format DBCL0100. For a description of the fields in this
format, see the Field Descriptions immediately following the table.</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Database file name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">0A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Database file library name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Database file member name</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Database file name.</strong> The database file name that another
process is attempting to lock. This is always the 10-character system name.</p>
<p><strong>Database file library name.</strong> The name of the library
containing the database file.</p>
<p><strong>Database file member name.</strong> The specific member that another
process is attempting to lock. If the member name is *NONE, a file lock is
being requested.</p>
<h3>Usage Notes</h3>
<h4>Registration considerations.</h4>
<p>Any exit program registered for this exit point must be threadsafe if it
will be called in a job that has multiple threads.</p>
<hr>
Exit program introduced: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"file1.htm">Database and File APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
<br>
</body>
</html>