90 lines
5.9 KiB
HTML
90 lines
5.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>Buffer Manipulation and Query APIs</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: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- DSMMST1 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
||
|
|
<!-- at RCHVMW2 on 29 Jan 1999 at 16:05:09 -->
|
||
|
|
<!-- File Edited November 2001 -->
|
||
|
|
<!-- 031111 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- 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>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Buffer Manipulation and Query APIs</h2>
|
||
|
|
|
||
|
|
<p>The buffer manipulation and query APIs are used to create, query, and
|
||
|
|
manipulate input and command buffers that interact with the screen.</p>
|
||
|
|
|
||
|
|
<p>The two buffer types used by the low-level interfaces are command and input.
|
||
|
|
A command buffer can be used to accumulate a sequence of low-level commands
|
||
|
|
without performing an I/O operation. The entire buffer can be written out at
|
||
|
|
once in a single I/O operation. See <a href="dsm1e.htm#HDRDIRECT">Direct and
|
||
|
|
Indirect Operations</a> for further discussion of command buffers. When an
|
||
|
|
input operation is performed, you can specify an input buffer as the target of
|
||
|
|
the operation. The input results are placed in this buffer, which can then be
|
||
|
|
queried through several interfaces. You may query for individual pieces of
|
||
|
|
information, such as the AID byte from the input operation using the Retrieve
|
||
|
|
AID Code on Read (QsnRtvReadAID) API or for multiple pieces of information
|
||
|
|
using the Retrieve Read Information (QsnRtvReadInf) API.</p>
|
||
|
|
|
||
|
|
<p>Command and input buffers can be used across activation groups if the
|
||
|
|
activation group in which the buffer was created still exists.</p>
|
||
|
|
|
||
|
|
<p>The buffer manipulation and query interfaces are:</p>
|
||
|
|
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
|
||
|
|
<!-- Updates made in this section *will* be overlaid by automated tools -->
|
||
|
|
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
|
||
|
|
<!--***************API BEGIN PASTE***************-->
|
||
|
|
<ul>
|
||
|
|
<li><A HREF="QsnClrBuf.htm">Clear Buffer</A> (QsnClrBuf) clears all commands or data in a buffer resets its state.</li>
|
||
|
|
<li><A HREF="QsnCpyBuf.htm">Copy Buffer</A> (QsnCpyBuf) copies the contents of one buffer to another.</li>
|
||
|
|
<li><A HREF="QsnCrtCmdBuf.htm">Create Command Buffer</A> (QsnCrtCmdBuf) creates a command buffer to accumulate low-level commands.</li>
|
||
|
|
<li><A HREF="QsnCrtInpBuf.htm">Create Input Buffer</A> (QsnCrtInpBuf) creates an input buffer to receive input results.</li>
|
||
|
|
<li><A HREF="QsnDltBuf.htm">Delete Buffer</A> (QsnDltBuf) deletes a buffer.</li>
|
||
|
|
<li><A HREF="QsnPutBuf.htm">Put Command Buffer</A> (QsnPutBuf) sends the commands in a command buffer to the screen.</li>
|
||
|
|
<li><A HREF="QsnPutGetBuf.htm">Put Command Buffer and Perform Get</A> (QsnPutGetBuf) sends the commands in a command buffer to the screen and performs a read operation.</li>
|
||
|
|
<li><A HREF="QsnRtvReadAID.htm">Retrieve AID Code on Read</A> (QsnRtvReadAID) determines the Aid code for a given input operation.</li>
|
||
|
|
<li><A HREF="QsnRtvAvailData.htm">Retrieve Available Data</A> (QsnRtvAvailData) copies the user's data into an input buffer.</li>
|
||
|
|
<li><A HREF="QsnRtvBufLen.htm">Retrieve Buffer Data Length</A> (QsnRtvBufLen) returns the length of data in a buffer.</li>
|
||
|
|
<li><A HREF="QsnRtvBufSiz.htm">Retrieve Buffer Size</A> (QsnRtvBufSiz) returns the size of a buffer.</li>
|
||
|
|
<li><A HREF="QsnRtvReadAdr.htm">Retrieve Cursor Address on Read</A> (QsnRtvReadAdr) retrieves the cursor position at the completion of an input operation.</li>
|
||
|
|
<li><A HREF="QsnRtvFldInf.htm">Retrieve Field Information</A> (QsnRtvFldInf) returns information about a particular field in an input buffer.</li>
|
||
|
|
<li><A HREF="QsnRtvDtaLen.htm">Retrieve Length of Data in Input Buffer</A> (QsnRtvDtaLen) retrieves the number of data bytes in an input buffer after an input operation.</li>
|
||
|
|
<li><A HREF="QsnRtvFldDtaLen.htm">Retrieve Length of Field Data in Buffer</A> (QsnRtvFldDtaLen) retrieves the number of bytes of field data after an input operation.</li>
|
||
|
|
<li><A HREF="QsnRtvReadLen.htm">Retrieve Number of Bytes Read from Screen</A> (QsnRtvReadLen) retrieves the number of data bytes read from the screen after an input operation.</li>
|
||
|
|
<li><A HREF="QsnRtvFldCnt.htm">Retrieve Number of Fields Read</A> (QsnRtvFldCnt) retrieves the number of fields in an input buffer.</li>
|
||
|
|
<li><A HREF="QsnRtvDta.htm">Retrieve Pointer to Data in Input Buffer</A> (QsnRtvDta) returns a pointer to the first byte of input data in an input buffer.</li>
|
||
|
|
<li><A HREF="QsnRtvFldDta.htm">Retrieve Pointer to Field Data</A> (QsnRtvFldDta) returns a pointer to the first byte of field data in an input buffer.</li>
|
||
|
|
<li><A HREF="QsnRtvReadInf.htm">Retrieve Read Information</A> (QsnRtvReadInf) returns information about the input operation.</li>
|
||
|
|
</ul>
|
||
|
|
<!--***************API END PASTE***************-->
|
||
|
|
<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>
|