$CommndL: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 4: | Line 4: | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommndL function is [[Run (Daemon function)]]. The OO APIs emphasize the use of the [[List of Daemon methods|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommndL function is [[Run (Daemon function)]]. The OO APIs emphasize the use of the [[List of Daemon methods|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p> | ||
This function allows a | This function allows a <var class="product">Model 204</var> command to be executed on an sdaemon with the results captured into a $list. $CommndL performs the same function as [[$Command]] except that data is returned to a $list rather than an image. | ||
The $CommndL function accepts five arguments and returns a number indicating the success of the function. It is also callable . | The $CommndL function accepts five arguments and returns a number indicating the success of the function. It is also callable . | ||
| Line 16: | Line 16: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>cmd</th> | <tr><th>cmd</th> | ||
<td>A string containing the | <td>A string containing the <var class="product">Model 204</var> command to be executed. This is a required argument.</td></tr> | ||
<tr><th>msgctl</th> | <tr><th>msgctl</th> | ||
<td>A number indicating the setting to be used for MSGCTL when issuing the command in the sdaemon. This is an optional parameter, and it defaults to the user's current MSGCTL setting.</td></tr> | <td>A number indicating the setting to be used for MSGCTL when issuing the command in the sdaemon. This is an optional parameter, and it defaults to the user's current MSGCTL setting.</td></tr> | ||
Revision as of 19:19, 16 June 2012
Execute Model 204 command on sdaemon, results to $list
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommndL function is Run (Daemon function). The OO APIs emphasize the use of the Daemon methods; users are strongly urged to use the new Daemon API instead of the old $functions.
This function allows a Model 204 command to be executed on an sdaemon with the results captured into a $list. $CommndL performs the same function as $Command except that data is returned to a $list rather than an image.
The $CommndL function accepts five arguments and returns a number indicating the success of the function. It is also callable .
Syntax
<section begin="syntax" /> %rc = $CommndL(cmd, msgctl, list_id, file, width) <section end="syntax" />
$COMMANDL Function
%rc is set to 0 or an error code.
| cmd | A string containing the Model 204 command to be executed. This is a required argument. |
|---|---|
| msgctl | A number indicating the setting to be used for MSGCTL when issuing the command in the sdaemon. This is an optional parameter, and it defaults to the user's current MSGCTL setting. |
| list_id | The identifier of the $list that is to receive the command output. This is an optional parameter; if omitted, command output is placed on the audit trail as "AD" lines. |
| file | A string indicating the name of a file that is to be automatically opened by the sdaemon and made the current file before cmd is executed. This file is opened with the same access privileges the user currently has for the file. This is an optional parameter. |
| width | A number indicating the line width to be used for output lines. This is an optional argument, and it defaults to 256. Under Sirius Mods Version 6.2 and earlier: if this value is not in the range 1-256, the default is used. Under Sirius Mods Version 6.3 and later: this value can be specified as any value between 1 and the minimum LOBUFF value for any sdaemon thread in the Online, and if the value is not a valid number or not in this range, the request is cancelled. |
0 - Command successfully executed 4 - Command processed, errors produced 8 - sdaemon restarted 12 - sdaemon required more input 16 - No sdaemons are running 20 - Out of storage 36 - Line control settings invalid 40 - Invalid file identifier
Return codes from $CommndL
The following program issues a VIEW command and displays the result at the user's terminal.
B %LIST = $ListNew %RC = $CommndL('VIEW', ,%LIST) FOR %I FROM 1 TO $ListCnt(%LIST) PRINT $ListInf(%LIST, %I) END FOR END