130 lines
4.9 KiB
HTML
130 lines
4.9 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>Start Job Session 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. -->
|
||
|
|
<!--File Edited November 2001 -->
|
||
|
|
<!--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>Start Job Session Exit Program</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<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%">Operation (INIT)</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(5)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">File system job handle</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(16)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">File system name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>Before applications can use the HFS APIs with your file system, you must supply a Start Job Session exit program for the file system.</p>
|
||
|
|
|
||
|
|
<p>The Start Job Session exit program controls access to the file system as a whole for each job in which that file system is used. The first time an application refers to a specific file system within a job by calling any HFS API, the HFS API performs these operations before performing its own function:</p>
|
||
|
|
|
||
|
|
<ol>
|
||
|
|
<li>Checks the application's authority to the Start Job Session exit program. Authority to the Start Job Session exit program provides authority to all other exit programs that are registered for use with the file system.</li>
|
||
|
|
|
||
|
|
<li>Locks the Start Job Session exit program in shared read (*SHRRD) mode to keep the file system from being deregistered while in use.</li>
|
||
|
|
|
||
|
|
<li>Calls the Start Job Session exit program. The Start Job Session exit program sets up a 16-byte area called a job handle for the file system to use during the job, and returns the job handle to the HFS API. The file system can use the job handle to store a pointer to a separate work area or as a work area in itself.</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<p>The following shows the input parameters that the API passes to your exit program and the output parameter that the exit program must pass back to the API:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Operation (INIT )</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(5)
|
||
|
|
|
||
|
|
<p>The abbreviation for the operation being performed (the letters INIT, for initialize, followed by a blank).</p></dd>
|
||
|
|
|
||
|
|
<dt><strong>File system job handle</strong></dt>
|
||
|
|
<dd>OUTPUT; CHAR(16)
|
||
|
|
|
||
|
|
<p>The work area or job handle for use by the file system. The file system returns the job handle to HFS on the Start Job Session. On all subsequent API calls, HFS returns the job handle to the file system.</p>
|
||
|
|
|
||
|
|
<p>The file system can keep whatever you choose in the job handle. For example, the job handle might contain a pointer giving the address of another work area or a control block used by the file system.</p></dd>
|
||
|
|
|
||
|
|
<dt><strong>File system name</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The name of the file system received from the application in the call to the HFS API. This parameter specifies which name the file system should use when it issues exceptions.</p></dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Messages for Exit Program Use</h3>
|
||
|
|
|
||
|
|
<p>This section lists the messages that the exit program can return to the API.</p>
|
||
|
|
|
||
|
|
<table cellpadding="3">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F75 E</td>
|
||
|
|
<td valign="top">Error occurred during start-job-session function.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
Exit Program Introduced: V2R1
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a
|
||
|
|
href="hfs1.htm">Hierarchical File System APIs</a> |
|
||
|
|
<a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|