$FunList: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:$FunList}} <span class="pageSubtitle"><section begin="desc" />$list of active and enqueued &FUNL requests<section end="desc" /></span> <p class="warning">Most Sir...")
 
m (misc cleanup)
 
(30 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$FunList}}
{{DISPLAYTITLE:$FunList}}
<span class="pageSubtitle"><section begin="desc" />$list of active and enqueued &FUNL requests<section end="desc" /></span>
<span class="pageSubtitle">$list of active and enqueued Fast/Unload requests</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $FunList function is [[to be entered]].</p>
This requests a list of active and enqueued <var class="product">[[Fast/Unload]]</var> requests. The list is returned to a [[$lists|$list]] that can be processed with the $list functions.  


The <var>$FunList</var> function accepts one argument and returns a numeric result.


The only argument is a destination $list identifier.


This requests a list of active and enqueued ''[[Fast/Unload]]'' requests. The list is returned to a $list that can be processed with the $list functions.
The $FunList function accepts one argument and returns a numeric result.
The only argument is a destination $list identifier.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RESULT = $FunList(list_identifier)
<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunList</span>(<span class="term">list_identifier</span>)
<section end="syntax" /></p>
<p class="caption">$FunList Function
</p>
</p>
<p class="caption">%RESULT is set either to 0, if the information was added to the $list, or to an error code if not.</p>
 
<p class="code">
<p>
3 - CCATEMP is full
<var class="term">%result</var> is set either to 0, if the information was added to the $list, or to a return code if not:
6 - Invalid $list identifier
</p>
</p>
<p class="caption">$FunList Error Codes
<p class="code">3 &mdash; CCATEMP is full
6 &mdash; Invalid $list identifier
</p>
</p>


 
==Usage notes==
Each item in the destination $list has the following format :
<ul>
<table class="syntaxTable">
<li>Each item in the destination $list has the following format:
<table class="thJustBold">
<tr><th>Col 1-8</th>
<tr><th>Col 1-8</th>
<td>Request number</td></tr>
<td>Request number</td></tr>
<tr><th>Col 11-18</th>
<tr><th>Col 11-18</th>
<td>Task number running request or blank if request still enqueued</td></tr>
<td>Task number running request or blank if request still enqueued</td></tr>
<tr><th>Col 21-30</th>
<tr><th>Col 21-30</th>
<td>Userid of request originator</td></tr>
<td>Userid of request originator</td></tr>
<tr><th>Col 33-40</th>
<tr><th>Col 33-40</th>
<td>User number of request originator</td></tr>
<td>User number of request originator</td></tr>
<tr><th>Col 43-50</th>
<tr><th>Col 43-50</th>
<td>Time request originated</td></tr>
<td>Time request originated</td></tr>
<tr><th>Col 53-60</th>
<tr><th>Col 53-60</th>
<td>DDNAME of file being unloaded
<td>DDNAME of file being unloaded</td></tr>
</td></tr></table>
</table></li>
For example, this statement sequence displays a list of all active and enqueued requests.
 
<li>A full screen <var class="product">Fast/Unload</var> request display procedure is provided with the <var class="product">Fast/Unload</var> distribution. It is called <code>FUNLIST CCAIN</code> in the CMS distribution, and it is member <code>FUNLIST</code> in the MVS distribution library.</li>
</ul>
 
==Example==
This statement sequence displays a list of all active and enqueued requests:
<p class="code"> %LIST = $ListNew
<p class="code"> %LIST = $ListNew
  %RC = $FunList(%LIST)
  %RC = $FunList(%LIST)
Line 49: Line 55:
</p>
</p>


 
==Products authorizing {{PAGENAMEE}}==
A full screen ''[[Fast/Unload]]'' request display procedure is provided with the ''[[Fast/Unload]]'' distribution. It is called FUNLIST CCAIN in the CMS distribution, and it is member FUNLIST in the MVS distribution library.<p>
<ul class="smallAndTightList">
 
<li>[[Fast/Unload User Language Interface]]
<ul>
 
<li>&FUNULI
 
</ul>
</ul>
</p>
<p class="caption">Products authorizing $FunList
</p>


[[Category:$Functions|$FunList]]
[[Category:$Functions|$FunList]]
[[Category:Fast/Unload SOUL Interface]]

Latest revision as of 19:56, 16 March 2015

$list of active and enqueued Fast/Unload requests

This requests a list of active and enqueued Fast/Unload requests. The list is returned to a $list that can be processed with the $list functions.

The $FunList function accepts one argument and returns a numeric result.

The only argument is a destination $list identifier.

Syntax

%result = $FunList(list_identifier)

%result is set either to 0, if the information was added to the $list, or to a return code if not:

3 — CCATEMP is full 6 — Invalid $list identifier

Usage notes

  • Each item in the destination $list has the following format:
    Col 1-8 Request number
    Col 11-18 Task number running request or blank if request still enqueued
    Col 21-30 Userid of request originator
    Col 33-40 User number of request originator
    Col 43-50 Time request originated
    Col 53-60 DDNAME of file being unloaded
  • A full screen Fast/Unload request display procedure is provided with the Fast/Unload distribution. It is called FUNLIST CCAIN in the CMS distribution, and it is member FUNLIST in the MVS distribution library.

Example

This statement sequence displays a list of all active and enqueued requests:

%LIST = $ListNew %RC = $FunList(%LIST) IF %RC GE 0 THEN FOR %I FROM 1 TO $ListCnt(%LIST) PRINT $ListInf(%LIST, %I) END FOR

Products authorizing $FunList

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$FunList&oldid=76562"