$List Global List and $List Session List: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />and $List_Session_List: List global/session $lists<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />and $List_Session_List: List global/session $lists<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <p class="warning">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.</p> | ||
$List_Global_List and $List_Session_List return information about global and session $lists to a $list. | $List_Global_List and $List_Session_List return information about global and session $lists to a $list. | ||
$List_Global_List and $List_Session_List accept one argument and return either of the following: | $List_Global_List and $List_Session_List accept one argument and return either of the following: | ||
<ul> | <ul> | ||
<li>The number of items added to the output $list. | <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. | <li>-3, if CCATEMP is full and the LISTFC parameter is not set. All other errors result in request cancellation. | ||
</ul> | </ul> | ||
The first argument is the $list identifier to receive the output from $List_Global_List or $List_Session_List. This is a required argument. | The first argument is the $list identifier to receive the output from $List_Global_List or $List_Session_List. This is a required argument. | ||
$List_Global_List and $List_Session_List are callable $functions (:hdref refid=callfun.). | $List_Global_List and $List_Session_List are callable $functions (:hdref refid=callfun.). | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> [%RC =] $List_Global_List(listid) | <p class="syntax"><section begin="syntax" /> [%RC =] $List_Global_List(listid) | ||
| Line 23: | Line 23: | ||
</p> | </p> | ||
<p class="caption">%RC is set to the number of added items or to -3.</p> | <p class="caption">%RC is set to the number of added items or to -3.</p> | ||
<p class="code"> | <p class="code"> | ||
[%RC =] $List_Session_List(listid) | [%RC =] $List_Session_List(listid) | ||
| Line 29: | Line 30: | ||
</p> | </p> | ||
<p class="caption">%RC is set to the number of added items or to -3.</p> | <p class="caption">%RC is set to the number of added items or to -3.</p> | ||
The format of the data in the output $list is | 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 38: | Line 41: | ||
The following example displays information about all current global and session $lists: | The following example displays information about all current global and session $lists: | ||
<p class="code"> %LIST = $ListNew | <p class="code"> %LIST = $ListNew | ||
%RC = $List_Global_List(%LIST) | %RC = $List_Global_List(%LIST) | ||
| Line 49: | Line 53: | ||
A $List_Session_List call when there is no session open causes a request cancellation | A $List_Session_List call when there is no session open causes a request cancellation. | ||
$List_Global_List is new in ''[[Sirius Mods]]'' Version 6.2. $List_Session_List is new in ''[[Sirius Mods]]'' Version 6.3.<p> | $List_Global_List is new in ''[[Sirius Mods]]'' Version 6.2. $List_Session_List is new in ''[[Sirius Mods]]'' Version 6.3.<p> | ||
Revision as of 20:09, 10 February 2011
<section begin="desc" />and $List_Session_List: List global/session $lists<section end="desc" />
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 accept one argument and return either of the following:
- 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.
The first argument is the $list identifier to receive the output from $List_Global_List or $List_Session_List. This is a required argument.
$List_Global_List and $List_Session_List are callable $functions (:hdref refid=callfun.).
Syntax
<section begin="syntax" /> [%RC =] $List_Global_List(listid) <section end="syntax" />
$GLOBAL_LIST
%RC is set to the number of added items or to -3.
[%RC =] $List_Session_List(listid)
$Session_List
%RC is set to the number of added items or to -3.
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. |
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)
A $List_Session_List call when there is no session open causes a request cancellation.
$List_Global_List is new in Sirius Mods Version 6.2. $List_Session_List is new in Sirius Mods Version 6.3.
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
Products authorizing $List_Global_List and $List_Session_List