$ProcOpn: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Open procedure for $PROCDAT, $PROCGET, $ProcLoc<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Open procedure for $PROCDAT, $PROCGET, $ProcLoc<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $ProcOpn function.</p> | ||
The $ProcOpn function is used to "open" a procedure as input to a User Language procedure via $PROCGET, $ProcDat and $ProcLoc. | The $ProcOpn function is used to "open" a procedure as input to a User Language procedure via [[$PROCGET]], [[$ProcDat]] and [[$ProcLoc]]. | ||
$ProcOpn accepts three arguments and returns a numeric code. As of ''[[Sirius Mods]]'' Version 6.8, it is a callable $function . | $ProcOpn accepts three arguments and returns a numeric code. As of ''[[Sirius Mods]]'' Version 6.8, it is a callable $function. | ||
The first argument is required and identifies the User Language procedure to be opened. | The first argument is required and identifies the [[User Language]] procedure to be opened. | ||
The second argument is an optional file name. If the second argument is not provided, or is a null string, the current file is used. | The second argument is an optional file name. If the second argument is not provided, or is a null string, the current file is used. | ||
The third argument is a string that is used by $ProcGet for dummy string substitution just as if this argument had been placed on an INCLUDE statement. Note that $ProcDat does no dummy string substitution. | The third argument is a string that is used by [[$ProcGet]] for dummy string substitution just as if this argument had been placed on an INCLUDE statement. Note that [[$ProcDat]] does no dummy string substitution. | ||
For example, suppose procedure TIS_PITY in procedure file HOHO contains the line | For example, suppose procedure TIS_PITY in procedure file HOHO contains the line | ||
<p class="code"> FIND1: IN ?? FIND ALL RECORDS FOR WHICH | <p class="code"> FIND1: IN ?? FIND ALL RECORDS FOR WHICH | ||
</p> | </p> | ||
the sequence | the sequence | ||
<p class="code"> %RESULT = $ProcOpn('TIS_PITY', 'HOHO', - | <p class="code"> %RESULT = $ProcOpn('TIS_PITY', 'HOHO', - | ||
vv ' THESE ARE ARGUMENTS') | |||
%LINE = $ProcGet | %LINE = $ProcGet | ||
</p> | </p> | ||
would result in %LINE being set to | would result in %LINE being set to | ||
<p class="code"> FIND1: IN THESE FIND ALL RECORDS FOR WHICH | <p class="code"> FIND1: IN THESE FIND ALL RECORDS FOR WHICH | ||
| Line 32: | Line 34: | ||
</p> | </p> | ||
<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> | ||
<p class="code"> | <p class="code"> | ||
-1 - Current include level not opened by $ProcOpn | -1 - Current include level not opened by $ProcOpn | ||
0 - Procedure opened without errors | |||
1 - Procedure is locked for edit or delete | |||
2 - Procedure does not exist or the current user does not | |||
have access privilege | |||
3 - Specified procedure name is invalid (null) | |||
4 - File name invalid, or no current file, or caller | |||
does not have sufficient privilege to | |||
display/include procedures | |||
5 - The maximum number of open procedures (5) | |||
has already been reached | |||
6 - Insufficient space in ITBL to hold third | |||
argument; increase the size of ITBL | |||
</p> | </p> | ||
<p class="caption">$ProcOpn return codes | <p class="caption">$ProcOpn return codes | ||
</p> | </p> | ||
After $ProcOpn has successfully opened a procedure, [[$ProcGet]] and [[$ProcDat]] may be used to retrieve the procedure source lines and $ProcLoc may be used to scan them.<p> | |||
<ul class="smallAndTightList"> | |||
<ul> | |||
<li>&SFUNC | <li>&SFUNC | ||
<li>&FUNULI | <li>&FUNULI | ||
<li>&JWEBS | <li>&JWEBS | ||
</ul> | </ul> | ||
<p class="caption">Products authorizing $ProcOpn | <p class="caption">Products authorizing $ProcOpn | ||
</p> | </p> | ||
[[Category:$Functions|$ProcOpn]] | [[Category:$Functions|$ProcOpn]] | ||
Revision as of 20:10, 2 February 2011
<section begin="desc" />Open procedure for $PROCDAT, $PROCGET, $ProcLoc<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $ProcOpn function.
The $ProcOpn function is used to "open" a procedure as input to a User Language procedure via $PROCGET, $ProcDat and $ProcLoc.
$ProcOpn accepts three arguments and returns a numeric code. As of Sirius Mods Version 6.8, it is a callable $function.
The first argument is required and identifies the User Language procedure to be opened.
The second argument is an optional file name. If the second argument is not provided, or is a null string, the current file is used.
The third argument is a string that is used by $ProcGet for dummy string substitution just as if this argument had been placed on an INCLUDE statement. Note that $ProcDat does no dummy string substitution.
For example, suppose procedure TIS_PITY in procedure file HOHO contains the line
FIND1: IN ?? FIND ALL RECORDS FOR WHICH
the sequence
%RESULT = $ProcOpn('TIS_PITY', 'HOHO', - vv ' THESE ARE ARGUMENTS') %LINE = $ProcGet
would result in %LINE being set to
FIND1: IN THESE FIND ALL RECORDS FOR WHICH
Syntax
<section begin="syntax" /> %RESULT = $ProcOpn(proc_name, file_name, inc_string) <section end="syntax" />
$ProcOpn Function
%RESULT is set to indicate the success of the function.
-1 - Current include level not opened by $ProcOpn 0 - Procedure opened without errors 1 - Procedure is locked for edit or delete 2 - Procedure does not exist or the current user does not have access privilege 3 - Specified procedure name is invalid (null) 4 - File name invalid, or no current file, or caller does not have sufficient privilege to display/include procedures 5 - The maximum number of open procedures (5) has already been reached 6 - Insufficient space in ITBL to hold third argument; increase the size of ITBL
$ProcOpn return codes
After $ProcOpn has successfully opened a procedure, $ProcGet and $ProcDat may be used to retrieve the procedure source lines and $ProcLoc may be used to scan them.
- &SFUNC
- &FUNULI
- &JWEBS
Products authorizing $ProcOpn