AppendOpenProcedure (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:AppendOpenProcedure subtitle}} | {{Template:Stringlist:AppendOpenProcedure subtitle}} | ||
This callable method adds lines to the end of a Stringlist from a procedure opened with $procopn | This callable method adds lines to the end of a <var>Stringlist</var> from a procedure opened with <var>$procopn</var>. | ||
AppendOpenProcedure is a member of the [[Stringlist class]]. | AppendOpenProcedure is a member of the [[Stringlist class]]. | ||
| Line 12: | Line 12: | ||
<td>A numeric variable that is set to zero if the function is a success.</td></tr> | <td>A numeric variable that is set to zero if the function is a success.</td></tr> | ||
<tr><th>sl</th> | <tr><th>sl</th> | ||
<td>A Stringlist object.</td></tr> | <td>A <var>Stringlist</var> object.</td></tr> | ||
<tr><th>numLines</th> | <tr><th>numLines</th> | ||
<td>The number of lines to be read. If this optional argument is not provided, reading continues from the input procedure to the end of that procedure.</td></tr> | <td>The number of lines to be read. If this optional argument is not provided, reading continues from the input procedure to the end of that procedure.</td></tr> | ||
<tr><th>seqIncrement</th> | <tr><th>seqIncrement</th> | ||
<td>A sequence number increment for 8-byte sequence numbers to be placed in front of each line in the output Stringlist. This sequence number indicates both the starting sequence number and the sequence number increment. If this parameter is not provided, no sequence numbers are placed in front of the input lines.</td></tr> | <td>A sequence number increment for 8-byte sequence numbers to be placed in front of each line in the output <var>Stringlist</var>. This sequence number indicates both the starting sequence number and the sequence number increment. If this parameter is not provided, no sequence numbers are placed in front of the input lines.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
< | All errors in <var>AppendOpenProcedure</var> result in request cancellation. | ||
The <var class="term">seqIncrement</var> argument to <var>AppendOpenProcedure</var> is intended for use in conjunction with the <var>[[Update (Stringlist function)|Update]] and [[Compare (Stringlist function)|Compare]] methods. | |||
==Examples== | ==Examples== | ||
| Line 26: | Line 28: | ||
In the following example of the AppendOpenProcedure method, procedure SUTPENS_HUNDRED in file JACKSON contains this request: | In the following example of the AppendOpenProcedure method, procedure SUTPENS_HUNDRED in file JACKSON contains this request: | ||
< | <p class="code"> | ||
b | b | ||
for %i from 1 to 10 | for %i from 1 to 10 | ||
| Line 32: | Line 34: | ||
end for | end for | ||
end | end | ||
</ | </p> | ||
The program example follows: | The program example follows: | ||
< | <p class="code"> | ||
b | b | ||
| Line 50: | Line 52: | ||
end | end | ||
</ | </p> | ||
The program result is a print of these lines: | The program result is a print of these lines: | ||
< | <p class="output"> | ||
00005000b | 00005000b | ||
00010000for %i from 1 to 10 | 00010000for %i from 1 to 10 | ||
| Line 60: | Line 62: | ||
00020000end for | 00020000end for | ||
00025000end | 00025000end | ||
</ | </p> | ||
[[Category:Stringlist methods|AppendOpenProcedure function]] | [[Category:Stringlist methods|AppendOpenProcedure function]] | ||
Revision as of 20:02, 17 January 2011
Add lines from procedure to Stringlist (Stringlist class)
This callable method adds lines to the end of a Stringlist from a procedure opened with $procopn.
AppendOpenProcedure is a member of the Stringlist class.
Syntax
[%rc =] sl:AppendOpenProcedure[( [numLines], [seqIncrement])]
Syntax terms
| %rc | A numeric variable that is set to zero if the function is a success. |
|---|---|
| sl | A Stringlist object. |
| numLines | The number of lines to be read. If this optional argument is not provided, reading continues from the input procedure to the end of that procedure. |
| seqIncrement | A sequence number increment for 8-byte sequence numbers to be placed in front of each line in the output Stringlist. This sequence number indicates both the starting sequence number and the sequence number increment. If this parameter is not provided, no sequence numbers are placed in front of the input lines. |
Usage notes
All errors in AppendOpenProcedure result in request cancellation.
The seqIncrement argument to AppendOpenProcedure is intended for use in conjunction with the Update and Compare methods.
Examples
In the following example of the AppendOpenProcedure method, procedure SUTPENS_HUNDRED in file JACKSON contains this request:
b for %i from 1 to 10 print %i end for end
The program example follows:
b %list is object stringList %rc is float %list = new %rc = $procopn('SUTPENS_HUNDRED', 'JACKSON') %list:appendOpenProcedure(,5000) %listrint end
The program result is a print of these lines:
00005000b 00010000for %i from 1 to 10 00015000 print %i 00020000end for 00025000end