AppendCPCommandOutput (Stringlist function) - Revision history

ELowell at 22:23, 2 September 2015

2015-09-02T22:23:21Z

← Older revision		Revision as of 22:23, 2 September 2015
Line 1:		Line 1:
	{{Template:Stringlist:AppendCPCommandOutput subtitle}}		{{Template:Stringlist:AppendCPCommandOutput subtitle}}

	This [[Notation conventions for methods#Callable functions\|callable]] method invokes a CP command in the Online's virtual machine and adds the output from that command to a <var>Stringlist</var>. The <var>AppendCPCommand</var> method accepts one or more arguments and returns a numeric result. Since CP commands are only available in a CMS environment, this method is useless when running under z/OS (MVS) or VSE and will result in request cancellation if invoked under those operating systems.		This [[Notation conventions for methods#Callable functions\|callable]] method invokes a CP command in the Online's virtual machine and adds the output from that command to a <var>Stringlist</var>. The <var>AppendCPCommand</var> method accepts one or more arguments and returns a numeric result. Since CP commands are only available in a CMS environment, this method is useless when running under z/OS (MVS) or VSE and will result in request cancellation if invoked under those operating systems.

JAL2 at 21:05, 4 May 2012

2012-05-04T21:05:06Z

← Older revision		Revision as of 21:05, 4 May 2012
Line 2:		Line 2:

	This [[Notation conventions for methods#Callable functions\|callable]] method invokes a CP command in the Online's virtual machine and adds the output from that command to a <var>Stringlist</var>. The <var>AppendCPCommand</var> method accepts one or more arguments and returns a numeric result. Since CP commands are only available in a CMS environment, this method is useless when running under z/OS (MVS) or VSE and will result in request cancellation if invoked under those operating systems.		This [[Notation conventions for methods#Callable functions\|callable]] method invokes a CP command in the Online's virtual machine and adds the output from that command to a <var>Stringlist</var>. The <var>AppendCPCommand</var> method accepts one or more arguments and returns a numeric result. Since CP commands are only available in a CMS environment, this method is useless when running under z/OS (MVS) or VSE and will result in request cancellation if invoked under those operating systems.

	==Syntax==		==Syntax==
	{{Template:Stringlist:AppendCPCommandOutput syntax}}		{{Template:Stringlist:AppendCPCommandOutput syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 18:		Line 20:

	==Usage notes==		==Usage notes==
	<ul><li>Since a CP command can do nasty things to an Online (like set storage or re-IPL the virtual machine), it is restricted to users with system manager privileges. An attempt to use it on a non-system manager account results in request cancellation.</li>		<ul><li>Since a CP command can do nasty things to an Online (like set storage, or re-IPL the virtual machine), it is restricted to users with system manager privileges. An attempt to use it on a non-system manager account results in request cancellation.</li>
	<li>If the CP command output ~~won't~~ fit into the output buffer the request is ~~canceled~~.</li>		<li>If the CP command output will not fit into the output buffer, the request is cancelled.</li>
	<li>Multiple CP commands can be issued in a single <var>AppendCpCommandoutput</var> invocation by separating them with an EBCDIC newline character (X'15') as in <code>%sl:AppendCpCommandOutput('Q SET' '15':x 'IND').</code></li>		<li>Multiple CP commands can be issued in a single <var>AppendCpCommandoutput</var> invocation by separating them with an EBCDIC newline character (X'15'), as in <code>%sl:AppendCpCommandOutput('Q SET' '15':x 'IND').</code></li>
	</ul>		</ul>

JAL2: /* Syntax terms */

2012-05-04T21:02:03Z

Syntax terms

← Older revision		Revision as of 21:02, 4 May 2012
Line 12:		Line 12:
	<td>The CP command to be issued.</td></tr>		<td>The CP command to be issued.</td></tr>
	<tr><th><var>BufferSize</var></th>		<tr><th><var>BufferSize</var></th>
	<td>The size of the virtual storage buffer to hold the result of the CP command. <var>AppendCpCommandOutput</var> uses Diagnose X'08' to issue the CP command and Diagnose X'08' requires that the output from the command go to a single contiguous buffer in virtual storage. This buffer is only used as a staging area to hold the command output until it is moved to the output <var>Stringlist</var>.<~~br/><br/~~>		<td>The size of the virtual storage buffer to hold the result of the CP command. <var>AppendCpCommandOutput</var> uses Diagnose X'08' to issue the CP command, and Diagnose X'08' requires that the output from the command go to a single contiguous buffer in virtual storage. This buffer is only used as a staging area to hold the command output until it is moved to the output <var>Stringlist</var>.
	~~The default value for~~ <var>BufferSize</var> ~~is 64K (65536) and~~ can ~~set~~ set to any value between 256 and 16M-1 (16777215). The default BufferSize is probably more than enough for almost all commands ~~and there~~ is probably little benefit to making the buffer smaller as it's only allocated for a fleeting instant.</td></tr>		<p>
			<var>BufferSize</var> can be set to any value between 256 and 16M-1 (16777215). The default BufferSize, 64K (65536), is probably more than enough for almost all commands. There is probably little benefit to making the buffer smaller, as it is only allocated for a fleeting instant. </p></td></tr>
	</table>		</table>

Alex: /* Examples */

2011-09-21T13:02:58Z

Examples

← Older revision		Revision as of 13:02, 21 September 2011
Line 23:		Line 23:

	==Examples==		==Examples==
			The following program issues a CP <code>QUERY NAMES</code> command and displays the output on the user's terminal:
			<p class="output">b
			%sl is object stringlist auto new
			%sl:appendCpCommandOutput('Q NAMES')
			%sl:print
			end
			</p>

	==See also==		==See also==
	{{Template:Stringlist:AppendCPCommandOutput footer}}		{{Template:Stringlist:AppendCPCommandOutput footer}}

Alex: /* Syntax terms */

2011-09-21T12:59:51Z

Syntax terms

← Older revision		Revision as of 12:59, 21 September 2011
Line 12:		Line 12:
	<td>The CP command to be issued.</td></tr>		<td>The CP command to be issued.</td></tr>
	<tr><th><var>BufferSize</var></th>		<tr><th><var>BufferSize</var></th>
	<td>The size of the virtual storage buffer to hold the result of the CP command. <var>AppendCpCommandOutput</var> uses Diagnose X'08' to issue the CP command and Diagnose X'08' requires that the output from the command go to a single contiguous ~~output~~ buffer. This buffer is only used as a staging area to hold the command output until it is moved to the output <var>Stringlist</var>.</td></tr>		<td>The size of the virtual storage buffer to hold the result of the CP command. <var>AppendCpCommandOutput</var> uses Diagnose X'08' to issue the CP command and Diagnose X'08' requires that the output from the command go to a single contiguous buffer in virtual storage. This buffer is only used as a staging area to hold the command output until it is moved to the output <var>Stringlist</var>.<br/><br/>
			The default value for <var>BufferSize</var> is 64K (65536) and can set set to any value between 256 and 16M-1 (16777215). The default BufferSize is probably more than enough for almost all commands and there is probably little benefit to making the buffer smaller as it's only allocated for a fleeting instant.</td></tr>
	</table>		</table>

Alex: /* Usage notes */

2011-09-21T12:53:37Z

Usage notes

← Older revision		Revision as of 12:53, 21 September 2011
Line 16:		Line 16:

	==Usage notes==		==Usage notes==
	<ul><li>Since a CP command can do nasty things to an Online (like set storage or re-IPL the virtual machine), it is restricted to users with system manager privileges.</li>		<ul><li>Since a CP command can do nasty things to an Online (like set storage or re-IPL the virtual machine), it is restricted to users with system manager privileges. An attempt to use it on a non-system manager account results in request cancellation.</li>
			<li>If the CP command output won't fit into the output buffer the request is canceled.</li>
			<li>Multiple CP commands can be issued in a single <var>AppendCpCommandoutput</var> invocation by separating them with an EBCDIC newline character (X'15') as in <code>%sl:AppendCpCommandOutput('Q SET' '15':x 'IND').</code></li>
	</ul>		</ul>

	==Examples==		==Examples==
	==See also==		==See also==
	{{Template:Stringlist:AppendCPCommandOutput footer}}		{{Template:Stringlist:AppendCPCommandOutput footer}}

Alex at 12:42, 21 September 2011

2011-09-21T12:42:01Z

← Older revision		Revision as of 12:42, 21 September 2011
Line 8:		Line 8:
	<tr><th>%rc</th><td>The return code from the issued CP command.</td></tr>		<tr><th>%rc</th><td>The return code from the issued CP command.</td></tr>
	<tr><th>sl</th>		<tr><th>sl</th>
	<td>Stringlist to receive output from the CP command.</td></tr>		<td>The <var>Stringlist</var> to receive output from the CP command.</td></tr>
	<tr><th>command</th>		<tr><th>command</th>
	<td>The CP command to be issued.</td></tr>		<td>The CP command to be issued.</td></tr>
	<tr><th><var>BufferSize</var></th>		<tr><th><var>BufferSize</var></th>
	<td>The size of the virtual storage buffer to hold the result of the CP command. AppendCpCommandOutput uses Diagnose X'08' to issue the CP command and Diagnose X'08' requires that the output from the command go to a single contiguous output buffer. This buffer is only used as a staging area to hold the command output until it is moved to the output ~~stringlist~~.</td></tr>		<td>The size of the virtual storage buffer to hold the result of the CP command. <var>AppendCpCommandOutput</var> uses Diagnose X'08' to issue the CP command and Diagnose X'08' requires that the output from the command go to a single contiguous output buffer. This buffer is only used as a staging area to hold the command output until it is moved to the output <var>Stringlist</var>.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
			<ul><li>Since a CP command can do nasty things to an Online (like set storage or re-IPL the virtual machine), it is restricted to users with system manager privileges.</li>
			</ul>
	==Examples==		==Examples==
	==See also==		==See also==
	{{Template:Stringlist:AppendCPCommandOutput footer}}		{{Template:Stringlist:AppendCPCommandOutput footer}}

Alex: /* Syntax terms */

2011-09-21T12:38:35Z

Syntax terms

← Older revision		Revision as of 12:38, 21 September 2011
Line 6:		Line 6:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%rc</th><td>~~number~~</td></tr>		<tr><th>%rc</th><td>The return code from the issued CP command.</td></tr>
	<tr><th>sl</th>		<tr><th>sl</th>
	<td>Stringlist ~~object~~</td></tr>		<td>Stringlist to receive output from the CP command.</td></tr>
	<tr><th>command</th>		<tr><th>command</th>
	<td>~~string~~</td></tr>		<td>The CP command to be issued.</td></tr>
	<tr><th><var>BufferSize</var></th>		<tr><th><var>BufferSize</var></th>
	<td>~~number~~</td></tr>		<td>The size of the virtual storage buffer to hold the result of the CP command. AppendCpCommandOutput uses Diagnose X'08' to issue the CP command and Diagnose X'08' requires that the output from the command go to a single contiguous output buffer. This buffer is only used as a staging area to hold the command output until it is moved to the output stringlist.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	==Examples==		==Examples==
	==See also==		==See also==
	{{Template:Stringlist:AppendCPCommandOutput footer}}		{{Template:Stringlist:AppendCPCommandOutput footer}}

Alex at 12:33, 21 September 2011

2011-09-21T12:33:14Z

← Older revision		Revision as of 12:33, 21 September 2011
Line 1:		Line 1:
	{{Template:Stringlist:AppendCPCommandOutput subtitle}}		{{Template:Stringlist:AppendCPCommandOutput subtitle}}

	This ~~page is~~ [[~~under construction~~]].		This [[Notation conventions for methods#Callable functions\|callable]] method invokes a CP command in the Online's virtual machine and adds the output from that command to a <var>Stringlist</var>. The <var>AppendCPCommand</var> method accepts one or more arguments and returns a numeric result. Since CP commands are only available in a CMS environment, this method is useless when running under z/OS (MVS) or VSE and will result in request cancellation if invoked under those operating systems.
	==Syntax==		==Syntax==
	{{Template:Stringlist:AppendCPCommandOutput syntax}}		{{Template:Stringlist:AppendCPCommandOutput syntax}}

DmeWiccan: Automatically generated page update

2011-09-20T21:45:30Z

Automatically generated page update

New page

{{Template:Stringlist:AppendCPCommandOutput subtitle}}

This page is [[under construction]].
==Syntax==
{{Template:Stringlist:AppendCPCommandOutput syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th><td>number</td></tr>
<tr><th>sl</th>
<td>Stringlist object</td></tr>
<tr><th>command</th>
<td>string</td></tr>
<tr><th><var>BufferSize</var></th>
<td>number</td></tr>
</table>
==Usage notes==
==Examples==
==See also==
{{Template:Stringlist:AppendCPCommandOutput footer}}