$Session List

Get list of sessions

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_List function is to be entered.

$Session_Create returns information about sessions to a $list, accepts three arguments and returns a the number of items added to the output $list. All errors result in request cancellation.

The first argument is the $list identifier to receive the output from $Session_List. This is a required argument.

The second argument is the session id for which information is to be returned. This argument can contain wildcards — for example "PEQ*" indicates that information is to be returned for all sessions beginning with the letters "PEQ". This is an optional argument and defaults to "*" meaning all session ids are to be listed.

The third argument is the session owner for which information is to be returned. This argument can contain wildcards though for a non-system manager user only sessions owned by the requesting user and public sessions will be listed. Note that a "*" will list all private and public sessions but a ""*" will list public sessions only. This is an optional argument and defaults to the userid of the invoking user.

Syntax

<section begin="syntax" />%rc = $Session_List(listid, sesid, owner) <section end="syntax" />

$Session_List

%RC is set to the number of added items.

The format of the data in the output $list is

Col 1-10	Owner of the session; * for public sessions.
Col 11-16	Session timeout value.
Col 17-30	Session creation time in YYYYMMDDHHMISS format.
Col 31-44	Last session access time in YYYYMMDDHHMISS format. If the session is currently open this value is the time of the $Session_List invocation and will have the same value for all sessions open at the time of the $Session_List call.
Col 45-50	User number with session open. If the session is not currently open by any users these columns contain all blanks.
Col 51-	The session id.

The session id and owner specified in the second and third arguments can be explicit names or can contain the following wildcard characters:

*	Matches any number of characters including none
?	Matches any single character
"	Indicates that the next character must be treated literally even if it is a wildcard character.

For example, "C*D" matches "CUSTID", "COD" or "CLOD". "S??T" matches "SALT", "SLOT" or "SORT". ""*" matches "*" that is public sessions in the case of the owner. The following example displays information about all sessions owned by the current user:

%LIST = $ListNew %RC = $Session_List(%LIST) %RC = $List_Print(%LIST)

For more information about sessions

This $function is new in Sirius Mods Version 6.3.

Products authorizing $Session_List

• Sirius functions
• Fast/Unload User Language Interface
• Janus Open Client
• Janus Open Server
• Janus Sockets
• Janus Web Server
• Japanese functions
• Sir2000 Field Migration Facility