$ProcDat: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Add lines from procedure to $list<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Add lines from procedure to $list<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ProcDat function is [[ | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ProcDat function is the [[AppendOpenProcedure (Stringlist function)]].</p> | ||
The $ProcDat function accepts three arguments, and returns a numeric code. | The $ProcDat function accepts three arguments, and returns a numeric code. | ||
| Line 11: | Line 11: | ||
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. | 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== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %RESULT = $ProcDat ( list_identifier, num_lines, seq_inc ) | <p class="syntax"><section begin="syntax" /> %RESULT = $ProcDat ( list_identifier, num_lines, seq_inc ) | ||
| Line 18: | Line 19: | ||
<p class="caption">%RESULT is set to indicate the success of the function.</p> | <p class="caption">%RESULT is set to indicate the success of the function.</p> | ||
The third argument to $ProcDat is intended for use in conjunction with the [[$ListUpd]] and [[$ListCmp]] functions. | |||
==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 | ||
| Line 29: | Line 29: | ||
END | END | ||
</p> | </p> | ||
This program: | This program: | ||
<p class="code"> B | <p class="code"> B | ||
| Line 44: | Line 46: | ||
</p> | </p> | ||
Prints the following: | |||
<p class="code"> 00005000B | <p class="code"> 00005000B | ||
00010000FOR %I FROM 1 TO 10 | 00010000FOR %I FROM 1 TO 10 | ||
| Line 53: | Line 54: | ||
00025000END | 00025000END | ||
</p> | </p> | ||
==Error codes== | |||
<p class="code"> | <p class="code"> | ||
-1 - Current include level not opened by $ProcOpn | -1 - Current include level not opened by $ProcOpn | ||
-3 - No room to create $list items | -3 - No room to create $list items | ||
(if LISTFC $SirParm parameter not set) | |||
-5 - Required parameter missing | -5 - Required parameter missing | ||
-6 - Invalid $list identifier | -6 - Invalid $list identifier | ||
| Line 62: | Line 65: | ||
<p class="caption">$ProcDat return codes | <p class="caption">$ProcDat return codes | ||
</p> | </p> | ||
<ul> | <ul> | ||
<li>[[Sirius $Functions]] | |||
<li> | <li>[[Fast/Unload User Language Interface]] | ||
<li>[[Janus Web Server]] | |||
<li> | |||
<li> | |||
</ul> | </ul> | ||
<p class="caption">Products authorizing $ProcDat | |||
<p class="caption">Products authorizing $ProcDat | |||
</p> | </p> | ||
[[Category:$Functions|$ProcDat]] | [[Category:$Functions|$ProcDat]] | ||
Revision as of 22:09, 1 February 2011
<section begin="desc" />Add lines from procedure to $list<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ProcDat function is the AppendOpenProcedure (Stringlist function).
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
<section begin="syntax" /> %RESULT = $ProcDat ( list_identifier, num_lines, seq_inc ) <section end="syntax" />
$ProcDat Function
%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.
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
Error 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
$ProcDat return codes
Products authorizing $ProcDat