View source for $EdScan

{{DISPLAYTITLE:$EdScan}}
<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>

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. 

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

==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>

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

<ul>
<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
 LOOP_VAR IS BINARY LEN 4
 NAME     IS STRING LEN 8
 SCOPE    IS STRING LEN 6
 TYPE     IS STRING LEN 8
 * THIS SECTION USED JUST FOR DATASETS + ALLOCATES
 DSNAME   IS STRING LEN 44
 DSORG    IS STRING LEN 10
 ALLOC    IS STRING LEN 4
 DISP     IS STRING LEN 5
 * THIS SECTION JUST USED FOR PRINTERS + PUNCHES
 CLASS    IS STRING LEN 1
 ROUTE    IS STRING LEN 8
 ID       IS STRING LEN 8
 DIST     IS STRING LEN 8
 FORMS    IS STRING LEN 8
 * THIS SECTION JUST USED FOR LINKS
 TRANSPORT   IS STRING LEN 8 AT DSNAME
 PROTOCOL    IS STRING LEN 8
 * THIS SECTION JUST USED FOR PROCESSES
 DESTINATION IS STRING LEN 8 AT DSNAME
 PARTNER     IS STRING LEN 10
 MODE        IS STRING LEN 4
 * THIS SECTION JUST USED FOR PROCESSGROUPS
 LINK        IS STRING LEN 8 AT DSNAME
 REMOTEID    IS STRING LEN 8
 TERMINAL    IS STRING LEN 8
 END IMAGE
</p>
ALLOC will return either NEW, OLD or COND and DISP returns either SHARE or EXCL. This is a required argument. 

<li>The second argument is a string indicating the type of entity for which information is to be returned. Valid types are
<table class="syntaxTable">
<tr><th>ALLOCATE</th>
<td>Files allocated by the ALLOCATE command.</td></tr>
<tr><th>DATASET</th>
<td>Files defined by the DEFINE DATASET command.</td></tr>
<tr><th>PRINTER</th>
<td>Printers defined by the DEFINE PRINTER command.</td></tr>
<tr><th>PUNCH</th>
<td>Punches defined by the DEFINE PUNCH command.</td></tr>
<tr><th>STREAM</th>
<td>Files defined by the DEFINE STREAM command.</td></tr>
<tr><th>PROCESS</th>
<td>Processes defined by the DEFINE PROCESS command.
</td></tr></table>
This is an optional argument. 

<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>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.
</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.

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

==Example==
The following program prints the DD and DSNAME of all ALLOCATE'd datasets.

<p class="code">B
IMAGE JUNK
LOOP_VAR IS BINARY LEN 4
 ...
END IMAGE
 
PREPARE IMAGE JUNK
REPEAT FOREVER
%RC = $EdScan('JUNK', 'ALLOCATE', 'SYSTEM')
IF %RC ^= 0 THEN
STOP
END IF
PRINT %JUNK:NAME AND %JUNK:DSNAME
END REPEAT
END
</p>

==Products authorizing {{PAGENAMEE}}== 
<ul class="smallAndTightList">
<li>[[List of $functions|Sirius functions]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li>
<li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Web Server]]</li>
<li>Japanese functions</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]</li>
</ul>
<p>
</p>

[[Category:$Functions|$EdScan]]