Images - Revision history

Goff: /* Identify statement */

2018-07-09T07:45:54Z

Identify statement

← Older revision		Revision as of 07:45, 9 July 2018
Line 1,277:		Line 1,277:
	<ul>		<ul>
	<li>Active image, if multiple images define the same block.</li>		<li>Active image, if multiple images define the same block.</li>
	<li>Length of items that were defined as <var>~~Inknown~~</var>.</li>		<li>Length of items that were defined as <var>Unknown</var>.</li>
	<li>Number of occurrences for arrays that were defined as <var>Unknown</var>. </li>		<li>Number of occurrences for arrays that were defined as <var>Unknown</var>. </li>
	</ul>		</ul>
Line 1,340:		Line 1,340:
	<p>		<p>
	You must issue a <var>Prepare</var> statement before another <var>Identify</var> statement can be issued on the same item. If you need to enlarge an array after the number of occurrences is established, you must copy the image (using assignment) to another image where the array is larger. </p>		You must issue a <var>Prepare</var> statement before another <var>Identify</var> statement can be issued on the same item. If you need to enlarge an array after the number of occurrences is established, you must copy the image (using assignment) to another image where the array is larger. </p>

	==Modify Buffer statement==		==Modify Buffer statement==

Dme: /* Defining image items */

2018-07-06T15:54:27Z

Defining image items

← Older revision		Revision as of 15:54, 6 July 2018
Line 404:		Line 404:
	</p>		</p>

	==Defining image items==		==<b id="imageItems"></b>Defining image items==
	<p>		<p>
	You must define each item in an image that is referred to by the request. Use an item definition to describe the following attributes for an item:</p>		You must define each item in an image that is referred to by the request. Use an item definition to describe the following attributes for an item:</p>
Line 783:		Line 783:
	<p>		<p>
	In the preceding example, <code>PRINT.LINE2</code> is placed adjacent to the end of <code>PRINT.LINE1</code>. Without the <var>After</var> clause, an <var>At</var> clause would be required to specify the numeric position of <code>PRINT.LINE2</code> in the image. </p>		In the preceding example, <code>PRINT.LINE2</code> is placed adjacent to the end of <code>PRINT.LINE1</code>. Without the <var>After</var> clause, an <var>At</var> clause would be required to specify the numeric position of <code>PRINT.LINE2</code> in the image. </p>

	==Defining arrays==		==Defining arrays==
	<p>		<p>

JAL: /* Using initialized disk space */ typo

2018-06-15T17:35:04Z

Using initialized disk space: typo

← Older revision		Revision as of 17:35, 15 June 2018
Line 371:		Line 371:
	====Using initialized disk space====		====Using initialized disk space====
	<p>		<p>
	Refining the previous code, the spaces between <code>~~PART 1~~</code>, <code>PART2</code>, and <code>PART3</code> are initialized by the intervening <var>Skip</var> statements: </p>		Refining the previous code, the spaces between <code>PART1</code>, <code>PART2</code>, and <code>PART3</code> are initialized by the intervening <var>Skip</var> statements: </p>
	<p class="code">R HDRCTL 0		<p class="code">R HDRCTL 0
	BEGIN		BEGIN

JAL: /* Image and End Image statements */ qualifying words for At clause

2018-06-14T23:03:01Z

Image and End Image statements: qualifying words for At clause

← Older revision		Revision as of 23:03, 14 June 2018
Line 266:		Line 266:
	</ul></li>		</ul></li>

	<li>The <var>At</var> clause is optional and specifies the starting location of a redefinition. If the <var>At</var> clause is omitted, the image ~~definition~~ starts at the beginning of the block. The location can be defined by one of the following options:		<li>The <var>At</var> clause is optional and specifies the starting location of a redefinition (that is, <var>At</var> is not suitable for the initial image in the block). If the <var>At</var> clause is omitted, the definition of this additional image starts at the beginning of the block. The location can be defined by one of the following options:
	<ul>		<ul>
	<li><var class="term">itemname</var> is the name of an item in a previously defined image in this block.</li>		<li><var class="term">itemname</var> is the name of an item in a previously defined image in this block.</li>

	<li><var class="term">~~imagename1~~</var> is the name of an image previously defined in this block.</li>		<li><var class="term">imagename</var> is the name of an image previously defined in this block.</li>

	<li><var class="term">arrayname</var> is the name of an array in a previously defined image in this block. </li>		<li><var class="term">arrayname</var> is the name of an array in a previously defined image in this block. </li>

JAL: /* Image and End Image statements */ definition of imageComponent

2018-06-14T21:49:50Z

Image and End Image statements: definition of imageComponent

← Older revision		Revision as of 21:49, 14 June 2018
Line 213:		Line 213:
	==Image and End Image statements==		==Image and End Image statements==
	<p>		<p>
	The <var>Image</var> statement starts the definition of an image block or of an additional image within the block. Each image can contain a description of the complete block, or it can redefine a portion of ~~another~~ image. An [[#End Image statemen\|End Image statement]] completes the image block. </p>		The <var>Image</var> statement starts the definition of an image block or of an additional image within the block. Each image can contain a description of the complete block, or it can redefine a portion of a preceding image in the block. An [[#End Image statemen\|End Image statement]] completes the image block. </p>

	====Syntax====		====Syntax====
Line 223:		Line 223:
	Where: </p>		Where: </p>
	<ul>		<ul>
	<li><var class="term">imagename</var> is the name of the image. Every image name defined in a request must be unique. The image name specified in the <var>Image</var> statement is assigned to the image being defined; other SOUL statements in the request can subsequently refer to this name.</li>		<li><var class="term">imagename</var> is the name of the image. Every image name defined in a request must be unique. The image name specified in the <var>Image</var> statement is assigned to the image being defined; other SOUL statements in the request can subsequently refer to this name. </li>

	<li><var>Namesave</var> is meaningful only for images used by certain $functions and OO methods: <var>$Field_Image</var>, <var>$Field_ListI</var>, and <var>AppendFieldImages</var>. </li>		<li><var>Namesave</var> is meaningful only for images used by certain $functions and OO methods: <var>$Field_Image</var>, <var>$Field_ListI</var>, and <var>AppendFieldImages</var>. </li>
Line 253:		Line 253:
	Common elements, as well as <var>Declare</var> and <var>Common</var>, are discussed in detail in [[Subroutines#Subroutines\|Subroutines]]. </p></li>		Common elements, as well as <var>Declare</var> and <var>Common</var>, are discussed in detail in [[Subroutines#Subroutines\|Subroutines]]. </p></li>

	<li><var class="term">imageComponent</var> is		<li><var class="term">imageComponent</var> is any of the following (which are described in detail on this page):
			<ul>
			<li>Item definition</li>

			<li>Array definition</li>

			<li>Reserved area definition </li>

			<li>Comment, blank line, or <var>Include</var> statement </li>

			<li>Image definition (multiple-image block) </li>
			</ul></li>

	<li>The <var>At</var> clause is optional and specifies the starting location of a redefinition. If the <var>At</var> clause is omitted, the image definition starts at the beginning of the block. The location can be defined by one of the following options:		<li>The <var>At</var> clause is optional and specifies the starting location of a redefinition. If the <var>At</var> clause is omitted, the image definition starts at the beginning of the block. The location can be defined by one of the following options:

JAL: /* Syntax */ reorder and add more syntax term definitions

2018-06-14T21:29:30Z

Syntax: reorder and add more syntax term definitions

← Older revision		Revision as of 21:29, 14 June 2018
Line 217:		Line 217:
	====Syntax====		====Syntax====
	<p>		<p>
	The format of the <var>Image</var> ~~statement~~ is:		The format of the <var>Image</var> block is:
	</p>		</p>
	~~<p class="syntax"><span class="squareb">[</span>[[Declare statement\|Declare]]<span class="squareb">]</span>~~{{Template:Image statement syntax}} </p>		{{Template:Image statement syntax}}
	Where:		<p>
			Where: </p>
	<ul>		<ul>
	<li><var class="term">imagename</var> is the name of the image. Every image name defined in a request must be unique. The image name specified in the <var>Image</var> statement is assigned to the image being defined; other SOUL statements in the request can subsequently refer to this name.</li>		<li><var class="term">imagename</var> is the name of the image. Every image name defined in a request must be unique. The image name specified in the <var>Image</var> statement is assigned to the image being defined; other SOUL statements in the request can subsequently refer to this name.</li>

	<li><var>Namesave</var> is meaningful only for images used by certain $functions and OO methods: <var>$Field_Image</var>, <var>$Field_ListI</var>, and <var>AppendFieldImages</var>. </li>		<li><var>Namesave</var> is meaningful only for images used by certain $functions and OO methods: <var>$Field_Image</var>, <var>$Field_ListI</var>, and <var>AppendFieldImages</var>. </li>

	<li>The <var>At</var> clause is optional and specifies the starting location of a redefinition. If the <var>At</var> clause is omitted, the image definition starts at the beginning of the block. The location can be defined by one of the following options:
	~~<ul>~~
	~~<li><var class="term">itemname</var> is the name of an item in a previously defined image in this block.</li>~~

	~~<li><var class="term">imagename1</var> is the name of an image previously defined in this block.</li>~~

	~~<li><var class="term">arrayname</var> is the name of an array in a previously defined image in this block. </li>~~
	~~</ul>~~

	~~<p class="note"><b>Note:</b>~~
	~~You cannot use the <var>At</var> clause with a <var>Global</var> image, since you can only define the first image in a multi-image block as a global image. </p></li>~~

	<li><var>Global</var> specifies to store the image in GTBL. Global images have an implied scope of <var>Common</var> (see below).		<li><var>Global</var> specifies to store the image in GTBL. Global images have an implied scope of <var>Common</var> (see below).
Line 263:		Line 252:
	<p>		<p>
	Common elements, as well as <var>Declare</var> and <var>Common</var>, are discussed in detail in [[Subroutines#Subroutines\|Subroutines]]. </p></li>		Common elements, as well as <var>Declare</var> and <var>Common</var>, are discussed in detail in [[Subroutines#Subroutines\|Subroutines]]. </p></li>

			<li><var class="term">imageComponent</var> is

			<li>The <var>At</var> clause is optional and specifies the starting location of a redefinition. If the <var>At</var> clause is omitted, the image definition starts at the beginning of the block. The location can be defined by one of the following options:
			<ul>
			<li><var class="term">itemname</var> is the name of an item in a previously defined image in this block.</li>

			<li><var class="term">imagename1</var> is the name of an image previously defined in this block.</li>

			<li><var class="term">arrayname</var> is the name of an array in a previously defined image in this block. </li>
			</ul>

			<p class="note"><b>Note:</b>
			You cannot use the <var>At</var> clause with a <var>Global</var> image, since you can only define the first image in a multi-image block as a global image. </p></li>
	</ul>		</ul>

JAL: reformat and add info to descriptions of Global and Common

2018-05-31T15:55:56Z

reformat and add info to descriptions of Global and Common

← Older revision		Revision as of 15:55, 31 May 2018
Line 238:		Line 238:
	You cannot use the <var>At</var> clause with a <var>Global</var> image, since you can only define the first image in a multi-image block as a global image. </p></li>		You cannot use the <var>At</var> clause with a <var>Global</var> image, since you can only define the first image in a multi-image block as a global image. </p></li>

	<li>Specifying <var>Common</var>, or specifying neither <var>Common</var> nor <var>Global</var>, results in the image being stored in FSCB. Common elements, as well as <var>Declare</var> and <var>Common</var>, are discussed in detail in [[Subroutines#Subroutines\|Subroutines]]. </li>		<li><var>Global</var> specifies to store the image in GTBL. Global images have an implied scope of <var>Common</var> (see below).
			<blockquote class="note">
	<li><var>Global</var> specifies to store the image in GTBL. Global images have an implied scope of <var>Common</var> (see ~~above~~). </li>		<p><b>Note:</b>
	</ul>		</p>
			<ul>
	~~====Restrictions to the Global option====~~		<li>You must not specify the <var>Global</var> attribute for an image that has an image item defined with either of the following attributes:
	<p>
	You must not specify the <var>Global</var> attribute for an image that has an image item defined with either of the following attributes: ~~</p>~~
	<ul>		<ul>
	<li><var>Occurs Unknown</var> </li>		<li><var>Occurs Unknown</var> </li>

	<li><var>Len Unknown</var> </li>		<li><var>Len Unknown</var> </li>
			</ul></li>

			<li>Images that share a block must have the same scope. For multi-image blocks, you can specify only the first image as <var>Global</var>; you must not specify subsequent images in a multi-image block as <var>Global</var>. Specifying the first image as <var>Global</var>, declares the entire block of images as <var>Global</var>. The same behavior and restrictions apply to <var>Common</var> images in a block. </li>
	</ul>		</ul>
	~~<p>~~		</blockquote></li>
	Images that share a block must have the same scope. For multi-image blocks, you can specify only the first image as <var>Global</var>; you must not specify subsequent images in a multi-image block as <var>Global</~~var~~>~~. Specifying the first image as <var>Global~~</~~var>, declares the entire block of images as <var>Global</var>. The same behavior and restrictions apply to <var>Common</var> images in a block. </p~~>
	~~<ul>~~
	<li><var>Permanent</var> can be used only with global images. Permanent global images persist across request boundaries; that is, they are maintained in GTBL even after a request has been terminated. </li>		<li><var>Permanent</var> can be used only with global images. Permanent global images persist across request boundaries; that is, they are maintained in GTBL even after a request has been terminated. </li>

	<li><var>Temporary</var> can be used with only global images. <var>Temporary</var> global images are allocated in GTBL, but are deleted at request termination. For example, use a <var>Temporary</var> global image when you do not need to pass the image to another request; using <var>Temporary</var> global images eliminates the need to explicitly delete globals that do not need to persist. </li>		<li><var>Temporary</var> can be used with only global images. <var>Temporary</var> global images are allocated in GTBL, but are deleted at request termination. For example, use a <var>Temporary</var> global image when you do not need to pass the image to another request; using <var>Temporary</var> global images eliminates the need to explicitly delete globals that do not need to persist. </li>

			<li><var>Common</var> images, or images that are neither <var>Common</var> nor <var>Global</var>, are stored in FSCB.
			<p>
			As described above for the <var>Global</var> option, you can specify only the first image in a multi-image block as <var>Common</var>, and you must not specify subsequent images in that block as <var>Common</var>. </p>
			<p>
			Common elements, as well as <var>Declare</var> and <var>Common</var>, are discussed in detail in [[Subroutines#Subroutines\|Subroutines]]. </p></li>
	</ul>		</ul>

JAL: /* Restrictions to the Global option */ scope of multiple images in a block must be the same

2018-05-31T15:34:27Z

Restrictions to the Global option: scope of multiple images in a block must be the same

← Older revision		Revision as of 15:34, 31 May 2018
Line 252:		Line 252:
	</ul>		</ul>
	<p>		<p>
	For multi-image blocks, you can specify only the first image as <var>Global</var>; you must not specify subsequent images in a multi-image block as <var>Global</var>.</p>		Images that share a block must have the same scope. For multi-image blocks, you can specify only the first image as <var>Global</var>; you must not specify subsequent images in a multi-image block as <var>Global</var>. Specifying the first image as <var>Global</var>, declares the entire block of images as <var>Global</var>. The same behavior and restrictions apply to <var>Common</var> images in a block. </p>
	<ul>		<ul>
	<li><var>Permanent</var> can be used only with global images. Permanent global images persist across request boundaries; that is, they are maintained in GTBL even after a request has been terminated. </li>		<li><var>Permanent</var> can be used only with global images. Permanent global images persist across request boundaries; that is, they are maintained in GTBL even after a request has been terminated. </li>
Line 258:		Line 258:
	<li><var>Temporary</var> can be used with only global images. <var>Temporary</var> global images are allocated in GTBL, but are deleted at request termination. For example, use a <var>Temporary</var> global image when you do not need to pass the image to another request; using <var>Temporary</var> global images eliminates the need to explicitly delete globals that do not need to persist. </li>		<li><var>Temporary</var> can be used with only global images. <var>Temporary</var> global images are allocated in GTBL, but are deleted at request termination. For example, use a <var>Temporary</var> global image when you do not need to pass the image to another request; using <var>Temporary</var> global images eliminates the need to explicitly delete globals that do not need to persist. </li>
	</ul>		</ul>

	===End Image statement===		===End Image statement===
	<p>		<p>

JAL: mention QA proc for example

2018-05-30T22:27:08Z

mention QA proc for example

← Older revision		Revision as of 22:27, 30 May 2018
Line 220:		Line 220:
	</p>		</p>
	<p class="syntax"><span class="squareb">[</span>[[Declare statement\|Declare]]<span class="squareb">]</span>{{Template:Image statement syntax}} </p>		<p class="syntax"><span class="squareb">[</span>[[Declare statement\|Declare]]<span class="squareb">]</span>{{Template:Image statement syntax}} </p>

	Where:		Where:
	<ul>		<ul>
Line 236:		Line 235:
	</ul>		</ul>

	<~~blockquote~~ class="note"~~><p~~><b>Note:</b>		<p class="note"><b>Note:</b>
	You cannot use the <var>At</var> clause with a <var>Global</var> image, since you can only define the first image in a multi-image block as a global image. </p>		You cannot use the <var>At</var> clause with a <var>Global</var> image, since you can only define the first image in a multi-image block as a global image. </p></li>
	<ul>
	<li>Specifying <var>Common</var>, or specifying neither <var>Common</var> nor <var>Global</var>, results in the image being stored in FSCB. Common elements, as well as <var>Declare</var> and <var>Common</var>, are discussed in detail in [[Subroutines#Subroutines\|Subroutines]]. </li>		<li>Specifying <var>Common</var>, or specifying neither <var>Common</var> nor <var>Global</var>, results in the image being stored in FSCB. Common elements, as well as <var>Declare</var> and <var>Common</var>, are discussed in detail in [[Subroutines#Subroutines\|Subroutines]]. </li>

	<li><var>Global</var> specifies to store the image in GTBL. Global images have an implied scope of <var>Common</var> (see above). </li>		<li><var>Global</var> specifies to store the image in GTBL. Global images have an implied scope of <var>Common</var> (see above). </li>
	</ul>		</ul>
	~~</blockquote>~~
	~~</li></ul>~~

	====Restrictions to the Global option====		====Restrictions to the Global option====
Line 312:		Line 309:
	AR.ACCT.NO IS STRING LEN 6		AR.ACCT.NO IS STRING LEN 6
	AR.BALANCE IS PACKED DIGITS 9 DP 2		AR.BALANCE IS PACKED DIGITS 9 DP 2
	END IMAGE		END IMAGE </p>
	</p>		<!-- above example is in Proc SOUL.DNC.001.QA from file QALOC in ULSPFDNC (2018/05/24 7:03:54 DNC) -->

	===Special considerations for multiple-image blocks===		===Special considerations for multiple-image blocks===
Line 1,284:		Line 1,281:
	===Establishing an active image===		===Establishing an active image===
	<p>		<p>
	Use the following form of the <var>Identify</var> statement to switch the active image to the named ~~imaged~~, when multiple images define the same block:</p>		Use the following form of the <var>Identify</var> statement to switch the active image to the named image, when multiple images define the same block:</p>
	<p class="syntax">Identify [Image] <span class="term">imagename</span>		<p class="syntax">Identify [Image] <span class="term">imagename</span>
	</p>		</p>
Line 1,294:		Line 1,291:
	====Use with global images====		====Use with global images====
	<p>		<p>
	When used with global images, the <var>Identify Image</var> statement, can cause request termination due to either: </p>		When used with global images, the <var>Identify Image</var> statement can cause request termination due to either of these: </p>
	<ul>		<ul>
	<li>Definition mismatches. See [[Global features#Consistency checks performed\|Consistency checks performed]] for a description.</li>		<li>Definition mismatches. See [[Global features#Consistency checks performed\|Consistency checks performed]] for a description. </li>

	<li>Insufficient space in [[~~Defining_the_runtime_environment_~~(CCAIN)#Understanding the global variable table (GTBL)\|GTBL]].		<li>Insufficient space in [[Defining the runtime environment (CCAIN)#Understanding the global variable table (GTBL)\|GTBL]]. </li>
	</li>
	</ul>		</ul>
	<p>		<p>
Line 1,311:		Line 1,307:
	</p>		</p>
	<p>		<p>
	The location of an item is established when the length of every preceding variable length item and array is established. The length cannot be changed after it is defined by an <var>Identify</var> statement. If you must enlarge an array after the length is established, copy the image to another image where the array is larger ~~using assignment statements~~.</p>		The location of an item is established when the length of every preceding variable length item and array is established. The length cannot be changed after it is defined by an <var>Identify</var> statement. If you must enlarge an array after the length is established, copy the image (using assignment statements) to another image where the array is larger.</p>

	===Establishing occurrences for Unknown arrays===		===Establishing occurrences for Unknown arrays===
Line 1,323:		Line 1,319:
	You cannot change the number of occurrences after they are defined by an <var>Identify</var> statement. If you issue an <var>Identify</var> statement for an item whose length was previously set by an <var>Identify</var> statement, the request is cancelled. </p>		You cannot change the number of occurrences after they are defined by an <var>Identify</var> statement. If you issue an <var>Identify</var> statement for an item whose length was previously set by an <var>Identify</var> statement, the request is cancelled. </p>
	<p>		<p>
	You must issue a <var>Prepare</var> statement before another <var>Identify</var> statement can be issued on the same item. If you need to enlarge an array after the number of occurrences is established, you must copy the image to another image where the array is larger ~~using assignment~~.</p>		You must issue a <var>Prepare</var> statement before another <var>Identify</var> statement can be issued on the same item. If you need to enlarge an array after the number of occurrences is established, you must copy the image (using assignment) to another image where the array is larger. </p>

	==Modify Buffer statement==		==Modify Buffer statement==

JAL: /* Image and End Image statements */ insert "Declare"

2018-05-29T19:09:26Z

Image and End Image statements: insert "Declare"

← Older revision		Revision as of 19:09, 29 May 2018
Line 219:		Line 219:
	The format of the <var>Image</var> statement is:		The format of the <var>Image</var> statement is:
	</p>		</p>
	<~~table~~ class="~~noBorder">~~		<p class="syntax"><span class="squareb">[</span>[[Declare statement\|Declare]]<span class="squareb">]</span>{{Template:Image statement syntax}} </p>
	~~<tr><td style="background-color: #f9f9f9; display:table-caption; margin-top:1.05em; padding-top:3px; font-family:Consolas,monospace; border: 1px dashed #4169E1;~~"><span class="squareb">[</span>Declare<span class="squareb">]</span~~> </td>~~
	~~<td~~>{{Template:Image statement syntax}} </~~td></tr>~~
	~~</table~~>

	Where:		Where: