$BldProc - Revision history

DCameron: /* Example */

2018-01-10T15:43:12Z

Example

← Older revision		Revision as of 15:43, 10 January 2018
Line 77:		Line 77:
	==Example==		==Example==
	<p>		<p>
	This sample request creates <var>[[UTABLE_command\|UTABLE]]</var> commands to restore three server table sizes (<var>LVTBL</var>, <var>LGTBL</var>, and <var>LSTBL</var>) before the table sizes are reset; <code>INCLUDE -1</code> at a later point will restore the table sizes. (See [[Large request considerations#User Language internal work areas\|User Language internal work areas]] for information on the <var>UTABLE</var> command.) This can be useful in a [[Application Subsystem development\|subsystem]] where the server table sizes are normally reset. </p>		This sample request creates <var>[[UTABLE_command\|UTABLE]]</var> commands to restore three server table sizes (<var>[[LVTBL_parameter\|LVTBL]]</var>, <var>[[LGTBL_parameter\|LGTBL]]</var>, and <var>[[LSTBL_parameter\|LSTBL]]</var>) before the table sizes are reset; <code>INCLUDE -1</code> at a later point will restore the table sizes. (See [[Large request considerations#User Language internal work areas\|User Language internal work areas]] for information on the <var>UTABLE</var> command.) This can be useful in a [[Application Subsystem development\|subsystem]] where the server table sizes are normally reset. </p>
	<p class="code">begin		<p class="code">begin
	%x is float		%x is float

DCameron: /* Example */

2018-01-10T15:41:23Z

Example

← Older revision		Revision as of 15:41, 10 January 2018
Line 77:		Line 77:
	==Example==		==Example==
	<p>		<p>
	This sample request creates <var>UTABLE</var> commands to restore three server table sizes (<var>LVTBL</var>, <var>LGTBL</var>, and <var>LSTBL</var>) before the table sizes are reset; <code>INCLUDE -1</code> at a later point will restore the table sizes. (See [[Large request considerations#User Language internal work areas\|User Language internal work areas]] for information on the <var>UTABLE</var> command.) This can be useful in a [[Application Subsystem development\|subsystem]] where the server table sizes are normally reset. </p>		This sample request creates <var>[[UTABLE_command\|UTABLE]]</var> commands to restore three server table sizes (<var>LVTBL</var>, <var>LGTBL</var>, and <var>LSTBL</var>) before the table sizes are reset; <code>INCLUDE -1</code> at a later point will restore the table sizes. (See [[Large request considerations#User Language internal work areas\|User Language internal work areas]] for information on the <var>UTABLE</var> command.) This can be useful in a [[Application Subsystem development\|subsystem]] where the server table sizes are normally reset. </p>
	<p class="code">begin		<p class="code">begin
	%x is float		%x is float

DCameron: /* How $BldProc works */

2018-01-10T15:40:23Z

How $BldProc works

← Older revision		Revision as of 15:40, 10 January 2018
Line 71:		Line 71:

	<p>		<p>
	Temporary procedures are stored in [[Using_the_system_scratch_file_(CCATEMP)\|CCATEMP]]. If an additional ~~CCAPTEMP~~ page is required to process a <var>$BldProc</var> call, but CCATEMP is full, then the request is cancelled and the entire temporary procedure is deleted. After the request is cancelled, the procedure does not contain everything up to the point of failure. In the event of CCATEMP filling while processing <var>$BldProc</var>, the following message is issued:</p>		Temporary procedures are stored in [[Using_the_system_scratch_file_(CCATEMP)\|CCATEMP]]. If an additional CCATEMP page is required to process a <var>$BldProc</var> call, but CCATEMP is full, then the request is cancelled and the entire temporary procedure is deleted. After the request is cancelled, the procedure does not contain everything up to the point of failure. In the event of CCATEMP filling while processing <var>$BldProc</var>, the following message is issued:</p>
	<p class="code"><b></b>*** CANCELLING REQUEST: M204.0441: CCATEMP FULL: $BLDPROC		<p class="code"><b></b>*** CANCELLING REQUEST: M204.0441: CCATEMP FULL: $BLDPROC
	</p>		</p>

DCameron: /* How $BldProc works */

2018-01-10T15:36:51Z

How $BldProc works

← Older revision		Revision as of 15:36, 10 January 2018
Line 59:		Line 59:
	<li>The specified temporary procedure is being included.</li>		<li>The specified temporary procedure is being included.</li>

	<li>Where a previous <var>USE PROC</var> command is also directing output to the same temporary procedure.</li>		<li>Where a previous <var>[[USE_PROC_command\|USE PROC]]</var> command is also directing output to the same temporary procedure.</li>

	<li>The <var class="term">action</var> argument is not one of the valid choices.</li>		<li>The <var class="term">action</var> argument is not one of the valid choices.</li>

DCameron: /* How $BldProc works */

2018-01-10T15:34:21Z

How $BldProc works

← Older revision		Revision as of 15:34, 10 January 2018
Line 71:		Line 71:

	<p>		<p>
	Temporary procedures are stored in [[Using_the_system_scratch_file_(CCATEMP)\CCATEMP]]. If an additional CCAPTEMP page is required to process a <var>$BldProc</var> call, but CCATEMP is full, then the request is cancelled and the entire temporary procedure is deleted. After the request is cancelled, the procedure does not contain everything up to the point of failure. In the event of CCATEMP filling while processing <var>$BldProc</var>, the following message is issued:</p>		Temporary procedures are stored in [[Using_the_system_scratch_file_(CCATEMP)\|CCATEMP]]. If an additional CCAPTEMP page is required to process a <var>$BldProc</var> call, but CCATEMP is full, then the request is cancelled and the entire temporary procedure is deleted. After the request is cancelled, the procedure does not contain everything up to the point of failure. In the event of CCATEMP filling while processing <var>$BldProc</var>, the following message is issued:</p>
	<p class="code"><b></b>*** CANCELLING REQUEST: M204.0441: CCATEMP FULL: $BLDPROC		<p class="code"><b></b>*** CANCELLING REQUEST: M204.0441: CCATEMP FULL: $BLDPROC
	</p>		</p>

DCameron: /* How $BldProc works */

2018-01-10T15:33:50Z

How $BldProc works

← Older revision		Revision as of 15:33, 10 January 2018
Line 71:		Line 71:

	<p>		<p>
	Temporary procedures are stored in CCATEMP. If an additional CCAPTEMP page is required to process a <var>$BldProc</var> call, but CCATEMP is full, then the request is cancelled and the entire temporary procedure is deleted. After the request is cancelled, the procedure does not contain everything up to the point of failure. In the event of CCATEMP filling while processing <var>$BldProc</var>, the following message is issued:</p>		Temporary procedures are stored in [[Using_the_system_scratch_file_(CCATEMP)\CCATEMP]]. If an additional CCAPTEMP page is required to process a <var>$BldProc</var> call, but CCATEMP is full, then the request is cancelled and the entire temporary procedure is deleted. After the request is cancelled, the procedure does not contain everything up to the point of failure. In the event of CCATEMP filling while processing <var>$BldProc</var>, the following message is issued:</p>
	<p class="code"><b></b>*** CANCELLING REQUEST: M204.0441: CCATEMP FULL: $BLDPROC		<p class="code"><b></b>*** CANCELLING REQUEST: M204.0441: CCATEMP FULL: $BLDPROC
	</p>		</p>

DCameron: /* Syntax */

2018-01-10T14:36:13Z

Syntax

← Older revision		Revision as of 14:36, 10 January 2018
Line 16:		Line 16:
	<li><var class="term">procNumber</var> is a [[Procedures#Working_with_temporary_procedures\|temporary procedure]] number. The number of procedures or requests saved for a user is controlled by the <var>[[NORQS parameter\|NORQS]]</var> parameter, which has a default value of 5. Procedure number 0 is the request currently being entered. Procedure -1 refers to the request entered before the most recent one, -2 to the one before that, and so on. Therefore, <var class="term">procNumber</var> must have a value between 0 and <code>-NORQS+1</code>. </li>		<li><var class="term">procNumber</var> is a [[Procedures#Working_with_temporary_procedures\|temporary procedure]] number. The number of procedures or requests saved for a user is controlled by the <var>[[NORQS parameter\|NORQS]]</var> parameter, which has a default value of 5. Procedure number 0 is the request currently being entered. Procedure -1 refers to the request entered before the most recent one, -2 to the one before that, and so on. Therefore, <var class="term">procNumber</var> must have a value between 0 and <code>-NORQS+1</code>. </li>

	<li><var class="term">text</var> is usually a single line to be appended to the temporary procedure. A single call to <var>$BldProc</var> can add more than one line of text by imbedding <var>LINEND</var> parameter characters (usually semicolons) in the <var class="term">text</var> argument. If the <var class="term">text</var> argument is null, the procedure is not changed.</li>		<li><var class="term">text</var> is usually a single line to be appended to the temporary procedure. A single call to <var>$BldProc</var> can add more than one line of text by imbedding <var>[[LINEND_parameter\|LINEND]]</var> parameter characters (usually semicolons) in the <var class="term">text</var> argument. If the <var class="term">text</var> argument is null, the procedure is not changed.</li>

	<li><var class="term">action</var> must be one of the options listed in the following table. Building a temporary procedure is similar to building a sequential file in that the procedure must be opened before any text can be added to it. When all of the desired text has been added, the procedure should be closed.		<li><var class="term">action</var> must be one of the options listed in the following table. Building a temporary procedure is similar to building a sequential file in that the procedure must be opened before any text can be added to it. When all of the desired text has been added, the procedure should be closed.

DCameron: /* Syntax */

2018-01-10T14:33:28Z

Syntax

← Older revision		Revision as of 14:33, 10 January 2018
Line 14:		Line 14:
	Where:</p>		Where:</p>
	<ul>		<ul>
	<li><var class="term">procNumber</var> is a temporary procedure number. The number of procedures or requests saved for a user is controlled by the <var>[[NORQS parameter\|NORQS]]</var> parameter, which has a default value of 5. Procedure number 0 is the request currently being entered. Procedure -1 refers to the request entered before the most recent one, -2 to the one before that, and so on. Therefore, <var class="term">procNumber</var> must have a value between 0 and <code>-NORQS+1</code>. </li>		<li><var class="term">procNumber</var> is a [[Procedures#Working_with_temporary_procedures\|temporary procedure]] number. The number of procedures or requests saved for a user is controlled by the <var>[[NORQS parameter\|NORQS]]</var> parameter, which has a default value of 5. Procedure number 0 is the request currently being entered. Procedure -1 refers to the request entered before the most recent one, -2 to the one before that, and so on. Therefore, <var class="term">procNumber</var> must have a value between 0 and <code>-NORQS+1</code>. </li>

	<li><var class="term">text</var> is usually a single line to be appended to the temporary procedure. A single call to <var>$BldProc</var> can add more than one line of text by imbedding <var>LINEND</var> parameter characters (usually semicolons) in the <var class="term">text</var> argument. If the <var class="term">text</var> argument is null, the procedure is not changed.</li>		<li><var class="term">text</var> is usually a single line to be appended to the temporary procedure. A single call to <var>$BldProc</var> can add more than one line of text by imbedding <var>LINEND</var> parameter characters (usually semicolons) in the <var class="term">text</var> argument. If the <var class="term">text</var> argument is null, the procedure is not changed.</li>

DCameron at 14:29, 10 January 2018

2018-01-10T14:29:06Z

← Older revision		Revision as of 14:29, 10 January 2018
Line 2:		Line 2:
	The <var>$BldProc</var> function enables a request or series of requests to build a temporary procedure. <var>$BldProc</var> is similar to the <var>[[PROCEDURE command\|PROCEDURE]]</var> system control command. </p>		The <var>$BldProc</var> function enables a request or series of requests to build a temporary procedure. <var>$BldProc</var> is similar to the <var>[[PROCEDURE command\|PROCEDURE]]</var> system control command. </p>
	<p>		<p>
	The procedure built by <var>$BldProc</var> can contain arbitrary commands or [[SOUL]] statements or other text. You can execute this procedure after the building request has ended, or you can edit the temporary procedure into a permanent procedure. The number of lines output to a temporary procedure by the <var>$BldProc</var> function within a request are controlled by the <var>MOUT</var> parameter. For more information about temporary procedures, see [[Procedures#Working with temporary procedures\|Working with temporary procedures]]. </p>		The procedure built by <var>$BldProc</var> can contain arbitrary commands or [[SOUL]] statements or other text. You can execute this procedure after the building request has ended, or you can edit the temporary procedure into a permanent procedure. The number of lines output to a temporary procedure by the <var>$BldProc</var> function within a request are controlled by the <var>[[MOUT_parameter\|MOUT]]</var> parameter. For more information about temporary procedures, see [[Procedures#Working with temporary procedures\|Working with temporary procedures]]. </p>
	<p>		<p>
	You can build only one procedure at a time. To add text to more than one procedure in rotation, you must close one procedure and reopen the next procedure.</p>		You can build only one procedure at a time. To add text to more than one procedure in rotation, you must close one procedure and reopen the next procedure.</p>

JAL: add example

2015-07-08T18:57:25Z

add example

← Older revision		Revision as of 18:57, 8 July 2015
Line 1:		Line 1:
	<p>		<p>
	The <var>$BldProc</var> function enables a request or series of requests to build a temporary procedure. <var>$BldProc</var> is similar to the <var>PROCEDURE</var> system control command. </p>		The <var>$BldProc</var> function enables a request or series of requests to build a temporary procedure. <var>$BldProc</var> is similar to the <var>[[PROCEDURE command\|PROCEDURE]]</var> system control command. </p>
	<p>		<p>
	The procedure built by <var>$BldProc</var> can contain arbitrary commands or [[SOUL]] statements or other text. You can execute this procedure after the building request has ended, or you can edit the temporary procedure into a permanent procedure. The number of lines output to a temporary procedure by the <var>$BldProc</var> function within a request are controlled by the <var>MOUT</var> parameter. For more information about temporary procedures, see [[Procedures#Working with temporary procedures\|Working with temporary procedures]]. </p>		The procedure built by <var>$BldProc</var> can contain arbitrary commands or [[SOUL]] statements or other text. You can execute this procedure after the building request has ended, or you can edit the temporary procedure into a permanent procedure. The number of lines output to a temporary procedure by the <var>$BldProc</var> function within a request are controlled by the <var>MOUT</var> parameter. For more information about temporary procedures, see [[Procedures#Working with temporary procedures\|Working with temporary procedures]]. </p>
Line 77:		Line 77:
	==Example==		==Example==
	<p>		<p>
	This sample request creates <var>UTABLE</var> commands to restore ~~two~~ server table sizes (<var>LVTBL</var>, <var>LGTBL</var>, and <var>LSTBL</var>) before the table sizes are reset; <~~var~~>INCLUDE -1</~~var~~> at a later point will restore the table sizes. (See [[Large request considerations#User Language internal work areas\|User Language internal work areas]] for information on the <var>UTABLE</var> command.) This can be useful in a subsystem where the server table sizes are normally reset. ~~(To learn about subsystems, see [[Application Subsystem development]].)~~ </p>		This sample request creates <var>UTABLE</var> commands to restore three server table sizes (<var>LVTBL</var>, <var>LGTBL</var>, and <var>LSTBL</var>) before the table sizes are reset; <code>INCLUDE -1</code> at a later point will restore the table sizes. (See [[Large request considerations#User Language internal work areas\|User Language internal work areas]] for information on the <var>UTABLE</var> command.) This can be useful in a [[Application Subsystem development\|subsystem]] where the server table sizes are normally reset. </p>
	<p class="code">begin		<p class="code">begin
	%x is float		%x is float
Line 96:		Line 96:
	UTABLE LSTBL 10000		UTABLE LSTBL 10000
	</p>		</p>
			<p class="note"><b>Note:</b> You can also use the [[PUSHUTABLE and POPUTABLE commands]] to preserve and restore these table sizes. </p>

			The following procedure code is an example of the usefulness of <var>$BldProc</var> for running dynamic code on the same thread from within a subsystem:

			<p class="code">begin
			$setg('NEXTPROC','SOMEWHERE_ELSE')
			%x = $bldProc(-1,'begin','OPEN')
			if %(system):currentTimeMilliseconds:mod(2) then
			%x = $bldProc(-1,'in SOMEFILE include SOMETHING_ODD')
			else
			%x = $bldProc(-1,'in SOMEFILE include SOMETHING_EVEN')
			end if
			%x = $bldProc(-1,'end','CLOSE')
			end
			I -1
			DELETE -1 </p>
			<p>
			As soon as control returns from whichever of the above <var>INCLUDE</var> statements that is run, the subsystem navigates to the next specified procedure (within the global <code>NEXTPROC</code>; in this case <code>SOMEWHERE_ELSE</code>). </p>


	[[Category:SOUL $functions]]		[[Category:SOUL $functions]]