$ProcDat: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Add lines from procedure to $list</span> | <span class="pageSubtitle">Add lines from procedure to $list</span> | ||
<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ProcDat function is | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ProcDat function is <var>[[AppendOpenProcedure (Stringlist function)|AppendOpenProcedure]]</var>.</p> | ||
The <var>$ProcDat</var> function accepts three arguments, and returns a numeric code. | The <var>$ProcDat</var> function accepts three arguments, and returns a numeric code. | ||
| Line 15: | Line 15: | ||
<p class="syntax"><span class="term">%result</span> = $ProcDat ( list_identifier, num_lines, seq_inc ) | <p class="syntax"><span class="term">%result</span> = $ProcDat ( list_identifier, num_lines, seq_inc ) | ||
</p> | </p> | ||
<p> | <p> | ||
<var class="term">%result</var> is set to indicate the success of the function.</p> | |||
The third argument to <var>$ProcDat</var> is intended for use in conjunction with the <var>[[$ListUpd]]</var> and <var>[[$ListCmp]]</var> functions. | |||
===Return codes=== | |||
<p class="code">-1 - Current include level not opened by $ProcOpn | |||
-3 - No room to create $list items | |||
(if LISTFC <var>$SirParm</var> parameter not set) | |||
-5 - Required parameter missing | |||
-6 - Invalid $list identifier | |||
</p> | </p> | ||
==Examples== | ==Examples== | ||
If procedure 'SUTPENS_HUNDRED' in file 'JACKSON' contains: | If procedure 'SUTPENS_HUNDRED' in file 'JACKSON' contains: | ||
<p class="code"> B | <p class="code">B | ||
FOR %I FROM 1 TO 10 | |||
PRINT %I | |||
END FOR | |||
END | |||
</p> | </p> | ||
This program: | This program: | ||
<p class="code"> B | <p class="code">B | ||
%LIST = $ListNew | |||
%RESULT = $ProcOpn('SUTPENS_HUNDRED', 'JACKSON') | |||
%RESULT = $ProcDat(%LIST, ,5000) | |||
FOR %I FROM 1 TO $ListCnt(%LIST) | |||
PRINT $ListInf(%LIST, %I) | |||
END FOR | |||
END | |||
</p> | </p> | ||
Prints the following: | Prints the following: | ||
<p class="code"> 00005000B | <p class="code">00005000B | ||
00010000FOR %I FROM 1 TO 10 | |||
00015000 PRINT %I | |||
00020000END FOR | |||
00025000END | |||
</p> | </p> | ||
| Line 71: | Line 67: | ||
<li>[[Janus Web Server]] | <li>[[Janus Web Server]] | ||
</ul> | </ul> | ||
[[Category:$Functions|$ProcDat]] | [[Category:$Functions|$ProcDat]] | ||
Revision as of 18:21, 19 July 2013
Add lines from procedure to $list
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ProcDat function is AppendOpenProcedure.
The $ProcDat function accepts three arguments, and returns a numeric code.
The first argument identifies the $list to which lines from the currently open procedure will be added as $list items. This is a required argument.
The second argument is an optional number of lines to be read. If the second argument is not provided, reading continues from the input procedure to the end of the procedure.
The third argument specifies a sequence number increment for 8 byte sequence numbers to be placed in front of each line in the output $list. 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.
Syntax
%result = $ProcDat ( list_identifier, num_lines, seq_inc )
%result is set to indicate the success of the function.
The third argument to $ProcDat is intended for use in conjunction with the $ListUpd and $ListCmp functions.
Return codes
-1 - Current include level not opened by $ProcOpn -3 - No room to create $list items (if LISTFC $SirParm parameter not set) -5 - Required parameter missing -6 - Invalid $list identifier
Examples
If procedure 'SUTPENS_HUNDRED' in file 'JACKSON' contains:
B FOR %I FROM 1 TO 10 PRINT %I END FOR END
This program:
B %LIST = $ListNew %RESULT = $ProcOpn('SUTPENS_HUNDRED', 'JACKSON') %RESULT = $ProcDat(%LIST, ,5000) FOR %I FROM 1 TO $ListCnt(%LIST) PRINT $ListInf(%LIST, %I) END FOR END
Prints the following:
00005000B 00010000FOR %I FROM 1 TO 10 00015000 PRINT %I 00020000END FOR 00025000END