$EdScan - Revision history

JAL: misc formatting

2017-08-03T19:56:41Z

misc formatting

← Older revision		Revision as of 19:56, 3 August 2017
Line 2:		Line 2:
	<span class="pageSubtitle">Scan list of entities in online</span>		<span class="pageSubtitle">Scan list of entities in online</span>

	<p class="warn"><b>Note: </b>Most ~~Sirius~~ $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $EdScan function.</p>		<p class="warn"><b>Note: </b>Most $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $EdScan function.</p>

	This function scans the list of defined entities in the online region. Entities can be 204 ~~datasets~~, sequential files or streams, printers, punches or processes.		This function scans the list of defined entities in the online region. Entities can be Model 204 data sets, sequential files or streams, printers, punches or processes.

	The <var>$EdScan</var> function accepts four arguments and returns a number indicating the success of the function.		The <var>$EdScan</var> function accepts four arguments and returns a number indicating the success of the function.
Line 12:		Line 12:
	</p>		</p>

	<p>		<ul>
	<var class="term">%result</var> is a 0 or to an error code.</p>		<li><var class="term">%result</var> is a 0 or to an error code.</li>

	<ul>		<li><var class="term">imageName</var> is a string identifying an image to receive returned data. This image must have the following format :
	<li>~~The first argument~~ is a string identifying an image to receive returned data. This image must have the following format :
	<p class="code"><nowiki>image entity		<p class="code"><nowiki>image entity
	loopVar is binary len 4		loopVar is binary len 4
Line 51:		Line 50:
	end image		end image
	</nowiki></p>		</nowiki></p>
	~~ALLOC will return either~~ NEW, OLD or COND and ~~DISP~~ returns ~~either~~ SHARE or EXCL. This is a required argument.		<p>
			<code>alloc</code> returns NEW, OLD, or COND, and <code>disp</code> returns SHARE or EXCL. This is a required argument. </p></li>

	<li>~~The second argument~~ is a string indicating the type of entity for which information is to be returned. Valid types are		<li><var class="term">type</var> is a string indicating the type of entity for which information is to be returned. Valid types are:
	<table class="~~syntaxTable~~">		<table class="thJustBold">
	<tr><th>ALLOCATE</th>		<tr><th>ALLOCATE</th>
	<td>Files allocated by the ALLOCATE command.</td></tr>		<td>Files allocated by the <var>ALLOCATE</var> command.</td></tr>

	<tr><th>DATASET</th>		<tr><th>DATASET</th>
	<td>Files defined by the DEFINE DATASET command.</td></tr>		<td>Files defined by the <var>DEFINE DATASET</var> command.</td></tr>

	<tr><th>PRINTER</th>		<tr><th>PRINTER</th>
	<td>Printers defined by the DEFINE PRINTER command.</td></tr>		<td>Printers defined by the <var>DEFINE PRINTER</var> command.</td></tr>

	<tr><th>PUNCH</th>		<tr><th>PUNCH</th>
	<td>Punches defined by the DEFINE PUNCH command.</td></tr>		<td>Punches defined by the <var>DEFINE PUNCH</var> command.</td></tr>

	<tr><th>STREAM</th>		<tr><th>STREAM</th>
	<td>Files defined by the DEFINE STREAM command.</td></tr>		<td>Files defined by the <var>DEFINE STREAM</var> command.</td></tr>

	<tr><th>PROCESS</th>		<tr><th>PROCESS</th>
	<td>Processes defined by the DEFINE PROCESS command.		<td>Processes defined by the <var>DEFINE PROCESS</var> command. </td></tr>
	</td></tr></table>		</table>
	This is an optional argument.		<p>
			This is an optional argument. </p></li>

	<li>~~The third argument~~ is a string indicating the scope of the entities for which information is to be returned. Valid scopes are 'SYSTEM' and 'USER'. This is an optional argument. If not specified, all entities are returned.		<li><var class="term">scope</var> is a string indicating the scope of the entities for which information is to be returned. Valid scopes are 'SYSTEM' and 'USER'.
			<p>
			This is an optional argument. If not specified, all entities are returned. </p></li>

	<li>~~The fourth argument~~ is the name of the entity for which information is to be returned. This is an optional argument but if it is specified, arguments 2 and 3 are also required.		<li><var class="term">name</var> is the name of the entity for which information is to be returned. This is an optional argument, but if it is specified, arguments 2 and 3 are also required. </li>
	</ul>		</ul>

	In the image ~~indicated by argument 1~~, ~~LOOP_VAR~~ must be set to the number of entries matching the selection criterion that are to be skipped. Upon return, <var>$EdScan</var> ~~will set LOOP_VAR~~ to the number of entries skipped plus one if an entity is returned ~~and~~ to the number of entries skipped ~~if not~~. Thus, multiple invocations of <var>$EdScan</var> without setting ~~LOOP_VAR will~~ return information on all appropriate entities.		In the <var class="term">imageName</var> image, <code>loopVar</code> must be set to the number of entries matching the selection criterion that are to be skipped. Upon return, <var>$EdScan</var> sets <code>loopVar</code> to the number of entries skipped plus one (if an entity is returned) or to the number of entries skipped (otherwise). Thus, multiple invocations of <var>$EdScan</var> without setting <code>loopVar</code> return information on all appropriate entities.

	===Status codes===		===Status codes===
	<p class="code"> 0 - Entity found, image set		<p class="code"> 0 - Entity found, image set
	4 - Entity not found, or off end of chain		4 - Entity not found, or off end of chain
	8 - Invalid argument 1 or argument 2		8 - Invalid argument 1 or argument 2
	12 - Argument 4 specified without argument 2 or 3		12 - Argument 4 specified without argument 2 or 3
	16 - Image specified by argument 1 not found		16 - Image specified by argument 1 not found
	20 - Image specified by argument 1 not active, or too short		20 - Image specified by argument 1 not active, or too short
	</p>		</p>

Line 118:		Line 126:
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>
	</ul>		</ul>
	~~<p>~~
	~~</p>~~

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

Dme: /* Example */

2017-07-26T12:17:46Z

Example

← Older revision		Revision as of 12:17, 26 July 2017
Line 90:		Line 90:

	<p class="code">begin		<p class="code">begin
	image ~~junk~~		image junkEntity
	var is binary len 4		var is binary len 4
	...		...
Line 97:		Line 97:
	prepare image junkEntity		prepare image junkEntity
	repeat forever		repeat forever
			<!-- Note that the first arg is intentionally shown with different casing than the image declaration: -->
	%rc = $edScan('junkentity', 'ALLOCATE', 'SYSTEM')		%rc = $edScan('junkentity', 'ALLOCATE', 'SYSTEM')
	if %rc then		if %rc then

Dme at 12:07, 26 July 2017

2017-07-26T12:07:33Z

← Older revision		Revision as of 12:07, 26 July 2017
Line 17:		Line 17:
	<ul>		<ul>
	<li>The first argument is a string identifying an image to receive returned data. This image must have the following format :		<li>The first argument is a string identifying an image to receive returned data. This image must have the following format :
	<p class="code">image entity		<p class="code"><nowiki>image entity
	loopVar is binary len 4		loopVar is binary len 4
	name is string len 8		name is string len 8
Line 50:		Line 50:
	terminal is string len 8		terminal is string len 8
	end image		end image
	</p>		</nowiki></p>
	ALLOC will return either NEW, OLD or COND and DISP returns either SHARE or EXCL. This is a required argument.		ALLOC will return either NEW, OLD or COND and DISP returns either SHARE or EXCL. This is a required argument.

Dme: /* Syntax */

2017-07-26T12:06:43Z

Syntax

← Older revision		Revision as of 12:06, 26 July 2017
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$EdScan</span>(<span class="term">~~image_name~~</span>, [<span class="term">type</span>], [<span class="term">scope</span>], [<span class="term">name</span>])		<p class="syntax"><span class="term">%result</span> = <span class="literal">$EdScan</span>(<span class="term">imageName</span>, [<span class="term">type</span>], [<span class="term">scope</span>], [<span class="term">name</span>])
	</p>		</p>

Dme at 12:06, 26 July 2017

2017-07-26T12:06:04Z

← Older revision		Revision as of 12:06, 26 July 2017
Line 95:		Line 95:
	end image		end image

	prepare image ~~junk~~		prepare image junkEntity
	repeat forever		repeat forever
	%rc = $edScan('~~junk~~', 'ALLOCATE', 'SYSTEM')		%rc = $edScan('junkentity', 'ALLOCATE', 'SYSTEM')
	if %rc then		if %rc then
	stop		stop

Dme: /* Example */

2017-07-26T12:04:11Z

Example

← Older revision		Revision as of 12:04, 26 July 2017
Line 89:		Line 89:
	The following program prints the DD and DSNAME of all ALLOCATE'd datasets.		The following program prints the DD and DSNAME of all ALLOCATE'd datasets.

	<p class="code">B		<p class="code">begin
	~~IMAGE JUNK~~		image junk
	~~LOOP_VAR IS BINARY LEN~~ 4		var is binary len 4
	...		...
	~~END IMAGE~~		end image

	~~PREPARE IMAGE JUNK~~		prepare image junk
	~~REPEAT FOREVER~~		repeat forever
	%RC = $~~EdScan~~('~~JUNK~~', 'ALLOCATE', 'SYSTEM')		%rc = $edScan('junk', 'ALLOCATE', 'SYSTEM')
	IF %~~RC ^= 0 THEN~~		if %rc then
	~~STOP~~		stop
	~~END IF~~		end if
	~~PRINT~~ %~~JUNK~~:~~NAME AND~~ %~~JUNK~~:~~DSNAME~~		print %junk:name and %junk:dsname
	~~END REPEAT~~		end repeat
	~~END~~		end
	</p>		</p>

Dme: /* Syntax */

2017-07-26T12:01:15Z

Syntax

← Older revision		Revision as of 12:01, 26 July 2017
Line 17:		Line 17:
	<ul>		<ul>
	<li>The first argument is a string identifying an image to receive returned data. This image must have the following format :		<li>The first argument is a string identifying an image to receive returned data. This image must have the following format :
	<p class="code"> ~~IMAGE EB_IMAGE~~		<p class="code">image entity
	~~LOOP_VAR IS BINARY LEN~~ 4		loopVar is binary len 4
	~~NAME~~ ~~IS STRING LEN~~ 8		name is string len 8
	~~SCOPE~~ ~~IS STRING LEN~~ 6		scope is string len 6
	~~TYPE~~ ~~IS STRING LEN~~ 8		type is string len 8
	* ~~THIS SECTION USED JUST FOR DATASETS~~ + ~~ALLOCATES~~
	~~DSNAME~~ ~~IS STRING LEN~~ 44		* This section used just for DATASET + ALLOCATE:
	~~DSORG~~ ~~IS STRING LEN~~ 10		dsname is string len 44
	~~ALLOC~~ ~~IS STRING LEN~~ 4		dsorg is string len 10
	~~DISP~~ ~~IS STRING LEN~~ 5		alloc is string len 4
	* ~~THIS SECTION JUST USED FOR PRINTERS~~ + ~~PUNCHES~~		disp is string len 5
	~~CLASS~~ ~~IS STRING LEN~~ 1
	~~ROUTE~~ ~~IS STRING LEN~~ 8		* This section just used for PRINTER + PUNCH:
	ID ~~IS STRING LEN~~ 8		class is string len 1
	~~DIST~~ ~~IS STRING LEN~~ 8		route is string len 8
	~~FORMS~~ ~~IS STRING LEN~~ 8		id is string len 8
	* ~~THIS SECTION JUST USED FOR LINKS~~		dist is string len 8
	~~TRANSPORT~~ ~~IS STRING LEN~~ 8 ~~AT DSNAME~~		forms is string len 8
	~~PROTOCOL~~ ~~IS STRING LEN~~ 8
	* ~~THIS SECTION JUST USED FOR PROCESSES~~		* This section just used for LINK:
	~~DESTINATION IS STRING LEN~~ 8 ~~AT DSNAME~~		transport is string len 8 at dsname
	~~PARTNER~~ ~~IS STRING LEN~~ 10		protocol is string len 8
	~~MODE~~ ~~IS STRING LEN~~ 4
	* ~~THIS SECTION JUST USED FOR PROCESSGROUPS~~		* This section just used for PROCESS:
	~~LINK~~ ~~IS STRING LEN~~ 8 ~~AT DSNAME~~		destination is string len 8 at dsname
	~~REMOTEID~~ ~~IS STRING LEN~~ 8		partner is string len 10
	~~TERMINAL~~ ~~IS STRING LEN~~ 8		mode is string len 4
	~~END IMAGE~~
			* This section just used for PROCESSGROUP:
			link is string len 8 at dsname
			remoteid is string len 8
			terminal is string len 8
			end image
	</p>		</p>
	ALLOC will return either NEW, OLD or COND and DISP returns either SHARE or EXCL. This is a required argument.		ALLOC will return either NEW, OLD or COND and DISP returns either SHARE or EXCL. This is a required argument.

JALWiccan: Automatically generated page update

2015-02-19T23:09:01Z

Automatically generated page update

← Older revision		Revision as of 23:09, 19 February 2015
Line 110:		Line 110:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>
	</ul>		</ul>
	<p>		<p>

JALWiccan: Automatically generated page update

2015-02-19T22:57:54Z

Automatically generated page update

← Older revision		Revision as of 22:57, 19 February 2015
Line 110:		Line 110:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/4/4b/~~SirfieldNew.pdf Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>
	</ul>		</ul>
	<p>		<p>

JALWiccan: Automatically generated page update

2015-02-19T22:37:58Z

Automatically generated page update

← Older revision		Revision as of 22:37, 19 February 2015
Line 106:		Line 106:
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[[Media:JosrvrNew.pdf\|Janus Open Server]</li>		<li>[[Media:JosrvrNew.pdf\|Janus Open Server]]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>