$Buffer Position: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
 
No edit summary
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$BUFFER_POSITION}}
{{DISPLAYTITLE:$Buffer_Position}}
<b>Function</b>
<b>Function</b>
<p>Returns the current Universal Buffer position</p>
<p>Returns the current Universal Buffer position</p>
<b>Syntax</b>
<b>Syntax</b>
<p class="code">$BUFFER_POSITION
<p class="code">$Buffer_Position
</p>
</p>
<b>Where</b>
<b>Where</b>
<p>The $BUFFER_POSITION function, which takes no arguments, returns numeric results for the following circumstances:</p>
<p>The $Buffer_Position function, which takes no arguments, returns numeric results for the following circumstances:</p>
<table>
<table>
<tr class="head">
<tr class="head">
Line 18: Line 18:
<tr>
<tr>
<td>MODIFY BUFFER NOPRESERVE</td>
<td>MODIFY BUFFER NOPRESERVE</td>
<td align="right">1</td>
<td>1</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</tr>
Line 27: Line 27:
</tr>
</tr>
<tr>
<tr>
<td>MQGET {image | %variable}</td>
<td>[[MQ/204_and_SOUL_statements#MQGET_statement|MQGET]] {image | %variable}</td>
<td>Byte after the last byte copied into the %variable or image. </td>
<td>Byte after the last byte copied into the %variable or image. </td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</tr>
<tr>
<tr>
<td>MQGET, running in an APSY subsystem with AUTOCOMMIT=NO</td>
<td>MQGET, running in an [[Application_Subsystem_development|APSY]] subsystem with AUTOCOMMIT=NO</td>
<td>Position after the last byte of the previous request</td>
<td>Position after the last byte of the previous request</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
Line 38: Line 38:
<tr>
<tr>
<td>MQGET BUFFER</td>
<td>MQGET BUFFER</td>
<td align="right">1</td>
<td>1</td>
<td>Beginning of the buffer.</td>
<td>Beginning of the buffer.</td>
</tr>
</tr>
<tr>
<tr>
<td>MQPUT or MQPUT1</td>
<td>[[MQ/204_and_SOUL_statements#MQPUT_statement|MQPUT]] or [[MQ/204_and_SOUL_statements#MQPUT1_statement|MQPUT1]]</td>
<td align="right">1</td>
<td>1</td>
<td>Beginning of the buffer.</td>
<td>Beginning of the buffer.</td>
</tr>
</tr>
Line 57: Line 57:
</tr>
</tr>
<tr>
<tr>
<td>All other User Language statements--including when MQ/204 is not linked in </td>
<td>All other User Language statements--including when [[MQ/204_overview|MQ/204]] is not linked in </td>
<td align="right">-1</td>
<td>-1</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</tr>
</table>
</table>
[[Category:SOUL $functions]]
[[Category:SOUL $functions]]

Latest revision as of 14:11, 11 January 2018

Function

Returns the current Universal Buffer position

Syntax

$Buffer_Position

Where

The $Buffer_Position function, which takes no arguments, returns numeric results for the following circumstances:

If the most recent statement was... System returns... Signifying...
MODIFY BUFFER NOPRESERVE 1  
MODIFY BUFFER PRESERVE Position is unchanged. If the new BUFFER size is less than this value, then it is set to the byte after the last byte in the BUFFER area.
MQGET {image | %variable} Byte after the last byte copied into the %variable or image.  
MQGET, running in an APSY subsystem with AUTOCOMMIT=NO Position after the last byte of the previous request  
MQGET BUFFER 1 Beginning of the buffer.
MQPUT or MQPUT1 1 Beginning of the buffer.
READ FROM BUFFER Position after the last byte read from the buffer. First byte read by a subsequent READ from BUFFER area without POSITION specified.
WRITE ON BUFFER Position after the last byte written to the buffer. First byte written by a subsequent WRITE to BUFFER area without POSITION specified.
All other User Language statements--including when MQ/204 is not linked in -1