$List Global List and $List Session List

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

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