$List Global List and $List Session List: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 5: Line 5:


<var>$List_Global_List</var> and <var>$List_Session_List</var> return information about global and session $lists to a $list.  
<var>$List_Global_List</var> and <var>$List_Session_List</var> return information about global and session $lists to a $list.  
<var>$List_Global_List</var> and <var>$List_Session_List</var> accept one argument and return either of the following:
<ul>
<li>The number of items added to the output $list.
<li>-3, if CCATEMP is full and the LISTFC parameter is not set. All other errors result in request cancellation.
</ul>
The first argument is the $list identifier to receive the output from <var>$List_Global_List</var> or <var>$List_Session_List</var>. This is a required argument.


<var>$List_Global_List</var> and <var>$List_Session_List</var> are [[Calling Sirius Mods $functions|callable]] $functions.
<var>$List_Global_List</var> and <var>$List_Session_List</var> are [[Calling Sirius Mods $functions|callable]] $functions.
Line 22: Line 13:
<p class="code">[%rc =] $List_Session_List(listid)</p>
<p class="code">[%rc =] $List_Session_List(listid)</p>


<p class="caption">%rc is set to the number of added items or to -3.</p>
===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>A numeric variable to receive either of these:
<ul>
<li>The number of items added to the output $list.
<li>-3, if CCATEMP is full and the LISTFC parameter is not set. All other errors result in request cancellation.
</ul></td></tr>
 
<tr><th>listid</th>
<td>The $list identifier to receive the output from <var>$List_Global_List</var> or <var>$List_Session_List</var>. This is a required argument.
</td></tr></table>


The format of the data in the output $list is
==Usage notes==
<ul>
<li>The format of the data in the output $list is
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>Col 1-10</th>
<tr><th>Col 1-10</th>
Line 33: Line 37:
</td></tr></table>
</td></tr></table>


==Usage notes==
<ul>
<li>A <var>$List_Session_List</var> call when there is no session open causes a request cancellation.  
<li>A <var>$List_Session_List</var> call when there is no session open causes a request cancellation.  
</ul>
</ul>

Revision as of 21:12, 25 October 2012

$List_Global_List and $List_Session_List: List global/session $lists

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $List_Global_List and $List_Session_List functions.

$List_Global_List and $List_Session_List return information about global and session $lists to a $list.

$List_Global_List and $List_Session_List are callable $functions.

Syntax

<section begin="syntax" />[%rc =] $List_Global_List(listid) <section end="syntax" />

[%rc =] $List_Session_List(listid)

Syntax terms

%rc A numeric variable to receive either of these:
  • The number of items added to the output $list.
  • -3, if CCATEMP is full and the LISTFC parameter is not set. All other errors result in request cancellation.
listid The $list identifier to receive the output from $List_Global_List or $List_Session_List. This is a required argument.

Usage notes

  • The format of the data in the output $list is
    Col 1-10 The EBCDIC number of items on the $list, right-justified.
    Col 11- The name of the global or session $list.
  • A $List_Session_List call when there is no session open causes a request cancellation.

Example

The following example displays information about all current global and session $lists:

%LIST = $ListNew %RC = $List_Global_List(%LIST) PRINT 'Global $lists:' %RC = $List_Print(%LIST) %LIST = $ListNew %RC = $List_Session_List(%LIST) PRINT 'Session $lists:' %RC = $List_Print(%LIST)


Products authorizing $List_Global_List and $List_Session_List

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$List_Global_List_and_$List_Session_List&oldid=33476"