Subroutines - Revision history

JDamon: /* DECLARE before CALL */

2025-01-29T19:56:04Z

DECLARE before CALL

← Older revision		Revision as of 19:56, 29 January 2025
Line 406:		Line 406:
	<li>Declare the formal parameter list with the <var>DECLARE</var> statement. When the <var>DECLARE</var> statement precedes the first <var>CALL</var>, the compiler generates the correct error messages, if problems are encountered. </li>		<li>Declare the formal parameter list with the <var>DECLARE</var> statement. When the <var>DECLARE</var> statement precedes the first <var>CALL</var>, the compiler generates the correct error messages, if problems are encountered. </li>

	<li>Place the subroutine before the first <var>CALL</var> statement.</li>		<li>Place the subroutine declaration before the first <var>CALL</var> statement.</li>
	</ul>		</ul>

	====Specifying a list of records====		====Specifying a list of records====
	<p>		<p>

JAL: add links

2018-05-30T00:05:30Z

add links

← Older revision		Revision as of 00:05, 30 May 2018
Line 608:		Line 608:
	<li>To declare lists without having to use an <code>In <i>filename</i> Clear List <i>listname</i></code> clause. See [[Lists#Creating and clearing a list\|Creating and clearing a list]]. </li>		<li>To declare lists without having to use an <code>In <i>filename</i> Clear List <i>listname</i></code> clause. See [[Lists#Creating and clearing a list\|Creating and clearing a list]]. </li>

	<li>To declare %variables, see [[Using variables and values in computation]]. </li>		<li>To declare %variables, see [[Using variables and values in computation#Declaring\|Declaring %variables and %variable arrays]]. </li>
	</ul>		</ul>

	====Syntax====		====Syntax====
	<p>		<p>
	~~The~~ format of the <var>Declare</var> statement is ~~as follows:~~ </p>		In the context of sharable elements, the format of the <var>Declare</var> statement is shown below. For information about using <var>Declare</var> for global elements, see [[Global features#Global objects\|Global objects]]. For the detailed syntax of <var>Declare</var>, see [[Statement syntax#Declare\|Statement syntax]].
			</p>
	<p class="syntax">Declare <span class="term">declaration</span>		<p class="syntax">Declare <span class="term">declaration</span>
	</p>		</p>

JAL: mixed case for statements

2018-05-29T22:56:05Z

mixed case for statements

← Older revision		Revision as of 22:56, 29 May 2018
Line 507:		Line 507:
	%NUMBERS IS FLOAT ARRAY(10,10)		%NUMBERS IS FLOAT ARRAY(10,10)
	%MAX IS FLOAT		%MAX IS FLOAT
	DECLARE SUBROUTINE MAXIMUM(FLOAT ARRAY(,), -		DECLARE SUBROUTINE MAXIMUM(FLOAT ARRAY(,), FLOAT OUTPUT)
	FLOAT OUTPUT)
	.		.
	.		.
Line 517:		Line 516:
	.		.

	SUBROUTINE MAXIMUM(%ARR IS FLOAT ARRAY(,), -		SUBROUTINE MAXIMUM(%ARR IS FLOAT ARRAY(,), %M IS FLOAT OUTPUT)
	%M IS FLOAT OUTPUT)
	%I IS FIXED		%I IS FIXED
	%J IS FIXED		%J IS FIXED
Line 543:		Line 541:
	The scope of an element refers to the area within a request in which an element has a particular meaning. In User Language, complex subroutines have a different scope than the remainder of the request (the elements of a complex subroutine differ from the elements outside the subroutine even when they have the same name). This concept applies to labels, lists, %variables and %variable arrays, menus, screens, and images.</p>		The scope of an element refers to the area within a request in which an element has a particular meaning. In User Language, complex subroutines have a different scope than the remainder of the request (the elements of a complex subroutine differ from the elements outside the subroutine even when they have the same name). This concept applies to labels, lists, %variables and %variable arrays, menus, screens, and images.</p>
	<p>		<p>
	The elements of the main request (the statements not enclosed by any ~~SUBROUTINE~~/~~END SUBROUTINE~~ statements) and the elements of all simple subroutines share the same scope. Simple subroutines share the same elements with the main request and all other simple subroutines within the request. </p>		The elements of the main request (the statements not enclosed by any <var>Subroutine</var>/<var>End Subroutine</var> statements) and the elements of all simple subroutines share the same scope. Simple subroutines share the same elements with the main request and all other simple subroutines within the request. </p>

	===Shareable elements===		===Shareable elements===
Line 551:		Line 549:
	====%variables and %variable arrays====		====%variables and %variable arrays====
	<p>		<p>
	You can share %variables if a <var>Declare</var> ~~%variable~~ or a %variable IS statement that declares the %variable as common is present in each portion of the request where you use the %variable. The %variable must have the same type, length, number of decimal places, and ~~FIELD SAVE~~ option in each declaration. </p>		You can share %variables if a <var>Declare <i>%variable</i></var> or a <var><i>%variable</i> Is</var> statement that declares the %variable as common is present in each portion of the request where you use the %variable. The %variable must have the same type, length, number of decimal places, and <var>Field Save</var> option in each declaration. </p>

	====Lists of records====		====Lists of records====
Line 572:		Line 570:
	You can share a menu or screen as common under the following conditions: </p>		You can share a menu or screen as common under the following conditions: </p>
	<ul>		<ul>
	<li>The first reference to the menu or screen must be the complete definition of the menu or screen, with the ~~COMMON~~ keyword following the ~~MENU~~ or ~~SCREEN~~ statement.</li>		<li>The first reference to the menu or screen must be the complete definition of the menu or screen, with the <var>Common</var> keyword following the <var>Menu</var> or <var>Screen</var> statement. </li>
	~~</li>~~
	<li>Other parts of the request can reference the same menu or screen by using an abbreviated declaration of the form:~~</li>~~		<li>Other parts of the request can reference the same menu or screen by using an abbreviated declaration of the form:
	<p class="code">~~DECLARE~~ [~~MENU~~ menuname \| ~~SCREEN~~ screenname] ~~COMMON~~		<p class="code">Declare [Menu <i>menuname</i> \| Screen <i>screenname</i>] Common </p>
	</p>
	<p>		<p>
	If the complete definition of the menu or screen exists, and if that definition was declared as common, the menu or screen is shared. If not, a compiler error results. Two or more complete menu or screen definitions with the ~~COMMON~~ keyword also result in a compiler error.</p>		If the complete definition of the menu or screen exists, and if that definition was declared as common, the menu or screen is shared. If not, a compiler error results. Two or more complete menu or screen definitions with the <var>Common</var> keyword also result in a compiler error. </p>
	<p>		<p>
	If you use a menu or screen %variable (:%variable) within a complex subroutine to refer to a ~~COMMON~~ screen element, you must include a ~~common~~ declaration for each possible value of the menu or screen name. </p>		If you use a menu or screen %variable (:%variable) within a complex subroutine to refer to a <var>Common</var> screen element, you must include a <var>Common</var> declaration for each possible value of the menu or screen name. </p>
	</li>		</li>
	</ul>		</ul>
Line 595:		Line 592:
	</ul>		</ul>

	===~~DECLARE~~ statement===		===Declare statement===
	<p>		<p>
	You can use the <var>Declare</var> statement to perform the following functions: </p>		You can use the <var>Declare</var> statement to perform the following functions: </p>
Line 606:		Line 603:
	Menus and screens are discussed in detail in [[Full-screen feature]]. </p>		Menus and screens are discussed in detail in [[Full-screen feature]]. </p>
	<p>		<p>
	Images are discussed in detail in [[Images]].</p>		Images are discussed in detail in [[Images]]. </p>

	<ul>		<ul>
Line 653:		Line 650:
	.		.
	.		.
	SUBROUTINE REGION(LIST RGNLST OUTPUT, -		SUBROUTINE REGION(LIST RGNLST OUTPUT, %REGION IS STRING)
	%REGION IS STRING)

	R1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH		R1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH REGION = %REGION
	REGION = %REGION
	R2: PLACE RECORDS IN R1 ON LIST RGNLIST		R2: PLACE RECORDS IN R1 ON LIST RGNLIST
	END SUBROUTINE		END SUBROUTINE
Line 669:		Line 664:
	However, if attributes, such as <var>String</var> or <var>Len</var>, are included in the redefinition, which differ from those previously defined, a compilation error occurs. In addition, if the variable is not previously defined, it is allocated based on the current default variable definition. </p>		However, if attributes, such as <var>String</var> or <var>Len</var>, are included in the redefinition, which differ from those previously defined, a compilation error occurs. In addition, if the variable is not previously defined, it is allocated based on the current default variable definition. </p>
	<p>		<p>
	For example, </p>		For example: </p>
	<p class="code">BEGIN		<p class="code">BEGIN
	VARIABLES ARE STRING LEN 20		VARIABLES ARE STRING LEN 20

JAL: /* Syntax */ typo

2018-05-29T20:00:20Z

Syntax: typo

← Older revision		Revision as of 20:00, 29 May 2018
Line 617:		Line 617:
	<p>		<p>
	The format of the <var>Declare</var> statement is as follows: </p>		The format of the <var>Declare</var> statement is as follows: </p>
	<p class="syntax">~~Decalre~~ <span class="term">declaration</span>		<p class="syntax">Declare <span class="term">declaration</span>
	</p>		</p>
	<p>		<p>
Line 639:		Line 639:
	Subroutine <span class="term">subname</span>[(<span class="term">type</span> [<span class="term">inout-option</span>] [,...]) ]		Subroutine <span class="term">subname</span>[(<span class="term">type</span> [<span class="term">inout-option</span>] [,...]) ]
	</p>		</p>

	====Example====		====Example====
	<p>		<p>

JAL: misc formatting

2018-05-25T01:10:05Z

misc formatting

Show changes

JAL: /* Outlining a simple subroutine */ add "nowrap"

2017-10-18T21:29:53Z

Outlining a simple subroutine: add "nowrap"

← Older revision		Revision as of 21:29, 18 October 2017
Line 37:		Line 37:

	<tr>		<tr>
	<td><var>END SUBROUTINE</var></td>		<td nowrap><var>END SUBROUTINE</var></td>
	<td>Indicates the end of the subroutine.</td></tr>		<td>Indicates the end of the subroutine.</td></tr>

Line 60:		Line 60:
	<li><var>CALL</var> statement</li>		<li><var>CALL</var> statement</li>
	</ol>		</ol>

	===SUBROUTINE statement===		===SUBROUTINE statement===
	<p>		<p>

Dme: /* Pausing during the request */

2017-10-15T01:40:07Z

Pausing during the request

← Older revision		Revision as of 01:40, 15 October 2017
Line 1,011:		Line 1,011:
	===Pausing during the request===		===Pausing during the request===
	<p>		<p>
	The ~~PAUSE~~ statement can be used with <var>On</var> units to cause the request to wait a specified ~~time~~ and then to retry the statement that caused the evaluation of the ON unit. ~~PAUSE~~ is typically used with the other <var>On</var> unit types (~~RECORD LOCKING CONFLICT~~ and ~~ON FIND CONFLICT~~) and is discussed in [[Record level locking and concurrency control]]. </p>		The <var>[[Pause statement\|Pause]]</var> statement can be used with <var>On</var> units to cause the request to wait a specified number of seconds and then to retry the statement that caused the evaluation of the <var>On</var> unit. <var>Pause</var> is typically used with the other <var>On</var> unit types (<var>On Record Locking Conflict</var> and <var>On Find Conflict</var>) and is discussed in [[Record level locking and concurrency control]]. </p>

			<p>The <var>[[$WakeUp]]</var> function is an alternative approach; it offers millisecond resolution pausing.</p>

	</div> <!-- end of toc limit div -->		</div> <!-- end of toc limit div -->

	[[Category:SOUL]]		[[Category:SOUL]]

JAL: `On` for ON unit

2016-04-15T21:37:32Z

<var>On</var> for ON unit

Show changes

Admin: misc formatting

2016-02-16T19:41:51Z