$CommndL - Revision history

DCameron at 13:50, 22 November 2018

2018-11-22T13:50:28Z

← Older revision		Revision as of 13:50, 22 November 2018
Line 55:		Line 55:
	end		end
	</p>		</p>

			==Products authorizing {{PAGENAMEE}}==
			<ul class="smallAndTightList">
			<li>[[Janus Sockets]]</li>
			<li>[[Janus Web Server]]</li>

			</ul>


	[[Category:$Functions\|$CommndL]]		[[Category:$Functions\|$CommndL]]

JAL: remove Sirius

2018-02-12T16:09:33Z

remove Sirius

← Older revision		Revision as of 16:09, 12 February 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Execute Model 204 command on sdaemon, results to $list</span>		<span class="pageSubtitle">Execute Model 204 command on sdaemon, results 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 $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="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$CommndL</var> 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 <var class="product">Model 204</var> command to be executed on an [[Sdaemons\|sdaemon]] with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an [[Images\|image]].		This function allows a <var class="product">Model 204</var> command to be executed on an [[Sdaemons\|sdaemon]] with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an [[Images\|image]].

	The <var>$CommndL</var> function accepts five arguments and returns a number indicating the success of the function. It is also [[Calling Sirius Mods $functions\|callable]].		The <var>$CommndL</var> function accepts five arguments and returns a number indicating the success of the function. It is also [[Calling Sirius Mods $functions\|callable]].

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%rc</span> = <span class="literal">$CommndL</span>(<span class="term">cmd</span>, [<span class="term">msgctl</span>], [<span class="term">list_id</span>], [<span class="term">file</span>], [<span class="term">width</span>])		<p class="syntax"><span class="term">%rc</span> = <span class="literal">$CommndL</span>(<span class="term">cmd</span>, [<span class="term">msgctl</span>], [<span class="term">list_id</span>], [<span class="term">file</span>], [<span class="term">width</span>])
Line 22:		Line 23:

	<tr><th>list_id</th>		<tr><th>list_id</th>
	<td>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 [[~~Tracking_system_activity_~~(CCAJRNL,~~_CCAAUDIT~~,~~_CCAJLOG~~)#~~Audit_trail_format~~\|audit trail]] as "RK" lines.</td></tr>		<td>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 [[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#Audit trail format\|audit trail]] as "RK" lines.</td></tr>

	<tr><th>file</th>		<tr><th>file</th>
Line 28:		Line 29:

	<tr><th>width</th>		<tr><th>width</th>
	<td>A number indicating the line width to be used for output lines. This is an optional argument, and it defaults to 256. This value can be specified as any value between 1 and the minimum <var>[[~~LOBUFF_parameter~~\|LOBUFF]]</var> 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.		<td>A number indicating the line width to be used for output lines. This is an optional argument, and it defaults to 256. This value can be specified as any value between 1 and the minimum <var>[[LOBUFF parameter\|LOBUFF]]</var> 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.
	</td></tr>		</td></tr>
	</table>		</table>

DCameron: /* Syntax */

2018-02-12T14:56:14Z

Syntax

← Older revision		Revision as of 14:56, 12 February 2018
Line 22:		Line 22:

	<tr><th>list_id</th>		<tr><th>list_id</th>
	<td>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 [[Tracking_system_activity_(CCAJRNL,_CCAAUDIT,_CCAJLOG)#Audit_trail_format\|audit trail]] as "AD" lines.</td></tr>		<td>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 [[Tracking_system_activity_(CCAJRNL,_CCAAUDIT,_CCAJLOG)#Audit_trail_format\|audit trail]] as "RK" lines.</td></tr>

	<tr><th>file</th>		<tr><th>file</th>

DCameron: /* Example */

2018-02-12T14:16:42Z

Example

← Older revision		Revision as of 14:16, 12 February 2018
Line 46:		Line 46:
	==Example==		==Example==
	The following program issues a <var>VIEW</var> command and displays the result at the user's terminal.		The following program issues a <var>VIEW</var> command and displays the result at the user's terminal.
	<p class="code">B		<p class="code">b
	%list = $ListNew		%list = $ListNew
	%rc = $CommndL('VIEW', ,%list)		%rc = $CommndL('VIEW', ,%list)
Line 52:		Line 52:
	PRINT $ListInf(%list, %i)		PRINT $ListInf(%list, %i)
	END FOR		END FOR
	~~END~~		end
	</p>		</p>

	[[Category:$Functions\|$CommndL]]		[[Category:$Functions\|$CommndL]]

DCameron: /* Syntax */

2018-02-12T14:09:02Z

Syntax

← Older revision		Revision as of 14:09, 12 February 2018
Line 28:		Line 28:

	<tr><th>width</th>		<tr><th>width</th>
	<td>A number indicating the line width to be used for output lines. This is an optional argument, and it defaults to 256. This value can be specified as any value between 1 and the minimum <var>[LOBUFF_parameter\|LOBUFF]]</var> 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.		<td>A number indicating the line width to be used for output lines. This is an optional argument, and it defaults to 256. This value can be specified as any value between 1 and the minimum <var>[[LOBUFF_parameter\|LOBUFF]]</var> 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.
	</td></tr>		</td></tr>
	</table>		</table>

DCameron: /* Syntax */

2018-02-12T14:08:41Z

Syntax

← Older revision		Revision as of 14:08, 12 February 2018
Line 28:		Line 28:

	<tr><th>width</th>		<tr><th>width</th>
	<td>A number indicating the line width to be used for output lines. This is an optional argument, and it defaults to 256. This value can be specified as any value between 1 and the minimum <var>LOBUFF</var> 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.		<td>A number indicating the line width to be used for output lines. This is an optional argument, and it defaults to 256. This value can be specified as any value between 1 and the minimum <var>[LOBUFF_parameter\|LOBUFF]]</var> 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.
	</td></tr>		</td></tr>
	</table>		</table>

DCameron: /* Syntax */

2018-02-12T14:01:13Z

Syntax

← Older revision		Revision as of 14:01, 12 February 2018
Line 22:		Line 22:

	<tr><th>list_id</th>		<tr><th>list_id</th>
	<td>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.</td></tr>		<td>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 [[Tracking_system_activity_(CCAJRNL,_CCAAUDIT,_CCAJLOG)#Audit_trail_format\|audit trail]] as "AD" lines.</td></tr>

	<tr><th>file</th>		<tr><th>file</th>

DCameron at 13:54, 12 February 2018

2018-02-12T13:54:15Z

← Older revision		Revision as of 13:54, 12 February 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>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="warn"><b>Note: </b>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 <var class="product">Model 204</var> command to be executed on an [[Sdaemons\|sdaemon]] with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an image.		This function allows a <var class="product">Model 204</var> command to be executed on an [[Sdaemons\|sdaemon]] with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an [[Images\|image]].

	The <var>$CommndL</var> function accepts five arguments and returns a number indicating the success of the function. It is also [[Calling Sirius Mods $functions\|callable]].		The <var>$CommndL</var> function accepts five arguments and returns a number indicating the success of the function. It is also [[Calling Sirius Mods $functions\|callable]].

JAL: misc cleanup

2017-02-14T00:02:09Z

misc cleanup

← Older revision		Revision as of 00:02, 14 February 2017
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>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="warn"><b>Note: </b>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 <var class="product">Model 204</var> command to be executed on an sdaemon with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an image.		This function allows a <var class="product">Model 204</var> command to be executed on an [[Sdaemons\|sdaemon]] with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an image.

	The <var>$CommndL</var> function accepts five arguments and returns a number indicating the success of the function. It is also [[Calling Sirius Mods $functions\|callable]].		The <var>$CommndL</var> function accepts five arguments and returns a number indicating the success of the function. It is also [[Calling Sirius Mods $functions\|callable]].
Line 11:		Line 11:
	</p>		</p>

	<~~p class="caption"~~> %rc is set to 0 or ~~an error~~ code.</p>		<table>
			<tr><th>%rc</th>
			<td>A numeric variable that is set to 0 or to a [[#Return codes\|return code]].</td></tr>

	~~<table class="syntaxTable">~~
	<tr><th>cmd</th>		<tr><th>cmd</th>
	<td>A string containing the <var class="product">Model 204</var> command to be executed. This is a required argument.</td></tr>		<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 <var>[[MSGCTL parameter\|MSGCTL]]</var> when issuing the command in the sdaemon. This is an optional parameter, and it defaults to the user's current <var>MSGCTL</var> setting.</td></tr>

	<tr><th>list_id</th>		<tr><th>list_id</th>
	<td>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.</td></tr>		<td>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.</td></tr>

	<tr><th>file</th>		<tr><th>file</th>
	<td>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.</td></tr>		<td>A string indicating the name of a file that is to be automatically opened by the sdaemon and made the current file before <var class="term">cmd</var> is executed. This file is opened with the same access privileges the user currently has for the file. This is an optional parameter.</td></tr>

	<tr><th>width</th>		<tr><th>width</th>
	<td>A number indicating the line width to be used for output lines. This is an optional argument, and it defaults to 256. Under <var class="product">[[Sirius Mods]]</var> Version 6.2 and earlier: if this value is not in the range 1-256, the default is used. Under <var class="product">[[Sirius Mods]]</var> 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.		<td>A number indicating the line width to be used for output lines. This is an optional argument, and it defaults to 256. This value can be specified as any value between 1 and the minimum <var>LOBUFF</var> 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.
	</td></tr>		</td></tr>
	</table>		</table>

			===Return codes===

	<p class="code"> 0 - Command successfully executed		<p class="code"> 0 - Command successfully executed
Line 35:		Line 42:
	36 - Line control settings invalid		36 - Line control settings invalid
	40 - Invalid file identifier		40 - Invalid file identifier
	~~</p>~~
	~~<p class="caption">Return codes from $CommndL~~
	</p>		</p>

	The following program issues a VIEW command and displays the result at the user's terminal.		==Example==
			The following program issues a <var>VIEW</var> command and displays the result at the user's terminal.
	<p class="code">B		<p class="code">B
	%~~LIST~~ = $ListNew		%list = $ListNew
	%RC = $CommndL('VIEW', ,%~~LIST~~)		%rc = $CommndL('VIEW', ,%list)
	FOR %I FROM 1 TO $ListCnt(%~~LIST~~)		FOR %i FROM 1 TO $ListCnt(%list)
	PRINT $ListInf(%~~LIST~~, %I)		PRINT $ListInf(%list, %i)
	END FOR		END FOR
	END		END
	</p>		</p>
	~~<p class="code">~~

	[[Category:$Functions\|$CommndL]]		[[Category:$Functions\|$CommndL]]

JALWiccan: Automatically generated page update

2013-07-18T20:30:00Z

Automatically generated page update

← Older revision		Revision as of 20:30, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Execute Model 204 command on sdaemon, results to $list</span>		<span class="pageSubtitle">Execute Model 204 command on sdaemon, results to $list</span>

	<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="warn"><b>Note: </b>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 <var class="product">Model 204</var> command to be executed on an sdaemon with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an image.		This function allows a <var class="product">Model 204</var> command to be executed on an sdaemon with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an image.

← Older revision		Revision as of 13:54, 12 February 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>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="warn"><b>Note: </b>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 <var class="product">Model 204</var> command to be executed on an [[Sdaemons\|sdaemon]] with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an image.		This function allows a <var class="product">Model 204</var> command to be executed on an [[Sdaemons\|sdaemon]] with the results captured into a $list. <var>$CommndL</var> performs the same function as [[$Command]] except that data is returned to a $list rather than an [[Images\|image]].

	The <var>$CommndL</var> function accepts five arguments and returns a number indicating the success of the function. It is also [[Calling Sirius Mods $functions\|callable]].		The <var>$CommndL</var> function accepts five arguments and returns a number indicating the success of the function. It is also [[Calling Sirius Mods $functions\|callable]].