<!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 AID Code on Read (QsnRtvReadAID) 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. --> <!-- DSMMST1 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 --> <!-- at RCHVMW2 on 29 Jan 1999 at 16:05:09 --> <!-- Change History: --> <!-- YYMMDD USERID Change description --> <!--File Edited October 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>Retrieve AID Code on Read (QsnRtvReadAID) API</h2> <div class="box" style="width: 70%;"> <br> Required Parameter:<br> <!-- iddvc RMBR --> <br> <table width="100%"> <tr> <td align="right" valign="top" width="10%">1</td> <td align="left" valign="top" width="50%">Input buffer handle</td> <td align="left" valign="top" width="20%">Input</td> <td align="left" valign="top" width="20%">Binary(4)</td> </tr> </table> <br> Omissible Parameter Group:<br> <!-- iddvc RMBR --> <br> <table width="100%"> <tr> <td align="right" valign="top" width="10%">2</td> <td align="left" valign="top" width="50%">AID code</td> <td align="left" valign="top" width="20%">Output</td> <td align="left" valign="top" width="20%">Char(1)</td> </tr> <tr> <td align="right" valign="top">3<br> </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> Returned Value:<br> <!-- iddvc RMBR --> <br> <table width="100%"> <tr> <td align="right" valign="top" width="10%"></td> <td align="left" valign="top" width="50%">AID code</td> <td align="left" valign="top" width="20%">Output</td> <td align="left" valign="top" width="20%">Char(1)</td> </tr> </table> <br> Default Public Authority: *USE<br> <!-- iddvc RMBR --> <br> Service Program: QSNAPI<br> <!-- iddvc RMBR --> <br> Threadsafe: No<br> <!-- iddvc RMBR --> <br> </div> <p>The Retrieve AID Code on Read (QsnRtvReadAID) API determines the AID code corresponding to the input operation that filled the given input buffer.</p> <br> <h3>Authorities and Locks</h3> <p>None</p> <br> <h3>Required Parameter</h3> <dl> <dt><strong>Input buffer handle</strong></dt> <dd>INPUT; BINARY(4) <p>A handle for the input buffer that contains the results of the input operation. The input buffer must be filled as a result of a Read Input Fields (QsnReadInp), Read Modified Fields (QsnReadMDT), or Read Modified Alternate (QsnReadMDTAlt) operation. If the input buffer is filled as a result of any other input operation, a CPFA32E error is issued.</p> </dd> </dl> <br> <h3>Omissible Parameter Group</h3> <dl> <dt><strong>AID code</strong></dt> <dd>OUTPUT; CHAR(1) <p>The variable that contains the AID code when the QsnRtvReadAID API has completed. See <a href="dsm1e.htm#HDRAID">AID-Generating Keys</a> for a description of the possible values.</p> </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>. If this parameter is omitted, diagnostic and escape messages are issued to the application.</p> </dd> </dl> <br> <h3>Returned Value</h3> <dl> <dt><strong>AID code</strong></dt> <dd>OUTPUT; CHAR(1) <p>This API returns the value for the AID code parameter or X'00' if an error occurs during processing.</p> </dd> </dl> <br> <h3>Error Messages</h3> <table width="100%" 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">CPF24B4 E</td> <td valign="top">Severe error while addressing parameter list.</td> </tr> <tr> <td align="left" valign="top">CPF3CF1 E</td> <td valign="top">Error code parameter not valid.</td> </tr> <tr> <td align="left" valign="top">CPF3CF2 E</td> <td valign="top">Error(s) occurred during running of &1 API.</td> </tr> <tr> <td align="left" valign="top">CPFA319 E</td> <td valign="top">No data in input buffer.</td> </tr> <tr> <td align="left" valign="top">CPFA31E E</td> <td valign="top">Required parameter &1 omitted.</td> </tr> <tr> <td align="left" valign="top">CPFA32E E</td> <td valign="top">Input data for query operation incorrect.</td> </tr> <tr> <td align="left" valign="top">CPFA32F E</td> <td valign="top">Buffer type incorrect.</td> </tr> <tr> <td align="left" valign="top">CPFA331 E</td> <td valign="top">Buffer handle incorrect.</td> </tr> <tr> <td align="left" valign="top">CPFA334 E</td> <td valign="top">Low level environment handle incorrect.</td> </tr> </table> <br> <hr> API introduced: V2R3 <hr> <center> <table cellpadding="2" cellspacing="2"> <tr align="center"> <td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href= "dsm.htm">Dynamic Screen Manager APIs</a> | <a href="aplist.htm">APIs by category</a></td> </tr> </table> </center> </body> </html>