216 lines
6.2 KiB
HTML
216 lines
6.2 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 Scan Signature (QP0LRTSG) 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. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- 020308 JTROUS Crt date, based on chgscanattr.htm, V5R3, DCR 98680 -->
|
||
|
|
<!-- 020417 JTROUS Major changes from I0 rework -->
|
||
|
|
<!-- 0206?? JET This file has undergone html cleanup June 2002 by JET -->
|
||
|
|
<!-- 020917 JTROUS Updates due to coding work -->
|
||
|
|
<!--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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Retrieve Scan Signature (QP0LRTSG) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
#include <qp0lrtsg.h>
|
||
|
|
void QP0LRTSG
|
||
|
|
(void *<em>ScanKey_Ptr</em>,
|
||
|
|
void *<em>ScanSign_Ptr</em>,
|
||
|
|
void *<em>Error_Code_Ptr</em>);
|
||
|
|
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>Retrieve Scan Signature (QP0LRTSG) API</strong> retrieves the
|
||
|
|
scan key signature associated with a specific scan key. The scan key and scan
|
||
|
|
key signature are used with the integrated file system scan-related exit points
|
||
|
|
to indicate a software level which is to be associated with the exit points'
|
||
|
|
exit program registrations.</p>
|
||
|
|
|
||
|
|
<p>The integrated file system scan-related exit points are:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="ifscloseexit.htm">Integrated File System Scan on Close Exit
|
||
|
|
Programs</a></li>
|
||
|
|
|
||
|
|
<li><a href="ifsopenexit.htm">Integrated File System Scan on Open Exit
|
||
|
|
Programs</a>.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<p>To change the scan key signature associated with a specific scan key, see <a
|
||
|
|
href="chgscansgn.htm">Change Scan Signature (QP0LCHSG) API</a>. For more
|
||
|
|
information on the integrated file system scan processing, see the
|
||
|
|
<a href="../ifs/rzaaxkickoff.htm">Integrated file system</a> information
|
||
|
|
in the Files and file systems topic.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong><em>ScanKey_Ptr</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) A pointer to a 20-byte character string that identifies the scan
|
||
|
|
key whose scan key signature is being retrieved. The scan key is one that was
|
||
|
|
specified when an exit program was registered or added to any of the integrated
|
||
|
|
file system scan-related exit points.<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<p>If the scan key has not yet been registered with any scan-related exit
|
||
|
|
program, CPFA0EA is sent.</p>
|
||
|
|
|
||
|
|
<p>See <a href="ifsopenexit.htm#HDRSCkey">Scan Key List and Scan Key
|
||
|
|
Signatures</a> in <a href="ifsopenexit.htm">Integrated File System Scan on Open
|
||
|
|
Exit Program</a> for more information.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><em>ScanSign_Ptr</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Output) A pointer to the 12-byte character string that identifies the scan
|
||
|
|
key signature that is currently associated with the specified <em>scan
|
||
|
|
key</em>.
|
||
|
|
|
||
|
|
<p>See <a href="ifsopenexit.htm#HDRSCkey">Scan Key List and Scan Key
|
||
|
|
Signatures</a> in <a href="ifsopenexit.htm">Integrated File System Scan on Open
|
||
|
|
Exit Program</a> for more information.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><em>Error_Code_Ptr</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input/Output) Pointer to an error code structure to receive error
|
||
|
|
information. See <a href="../apiref/error.htm#hdrerrcod">Error code parameter</a> for
|
||
|
|
more information.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Authorities</h3>
|
||
|
|
|
||
|
|
<p>None</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<p>The following messages may be sent from this function:</p>
|
||
|
|
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF3C36 E</td>
|
||
|
|
<td width="85%" valign="top">
|
||
|
|
Number of parameters, &1, entered for this API was not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF3CF1 E</td>
|
||
|
|
<td width="85%" valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF2 E</td>
|
||
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFA0D4 E</td>
|
||
|
|
<td valign="top">File system error occurred. Error number &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFA0EA E</td>
|
||
|
|
<td valign="top">Scan key &1 does not exist.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The <<strong>qp0lrtsg.h</strong>> file (see <a href="unix13.htm">
|
||
|
|
Header Files for UNIX-Type Functions</a>)</li>
|
||
|
|
|
||
|
|
<li><a href="ifscloseexit.htm">Integrated File System Scan on Close Exit
|
||
|
|
Program</a></li>
|
||
|
|
|
||
|
|
<li><a href="ifsopenexit.htm">Integrated File System Scan on Open Exit
|
||
|
|
Programs</a></li>
|
||
|
|
|
||
|
|
<li><a href="chgscansgn.htm">Change Scan Signature (QP0LCHSG) API</a></li>
|
||
|
|
|
||
|
|
<li><a href="qgetattr.htm">Qp0lGetAttr()</a>--Get Attributes.</li>
|
||
|
|
|
||
|
|
<li><a href="qsetattr.htm">Qp0lSetAttr()</a>--Set Attributes.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Example</h3>
|
||
|
|
|
||
|
|
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
|
||
|
|
for information pertaining to code examples.</p>
|
||
|
|
|
||
|
|
<p>See <a href="chgscansgn.htm">Change Scan Signature (QP0LCHSG) API</a> for
|
||
|
|
an example showing a call to the <strong>Change Scan Signature
|
||
|
|
(QP0LCHSG)</strong> and the <strong>Retrieve Scan Signature
|
||
|
|
(QP0LRTSG)</strong> APIs.</p>
|
||
|
|
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R3
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"unix2.htm">Integrated File System APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|