SessionList (Object function)

From m204wiki
Revision as of 19:21, 27 August 2014 by JAL (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Get list of session objects (Object class)

[Introduced in Sirius Mods 7.8]


Syntax

%persObjList = %(Object):SessionList[( [string])]

Syntax terms

%persObjList An Arraylist of Object PersistentObjectInfo object variable.
%(Object) The class name in parentheses denotes a shared method. SessionList can also be invoked via an Object class object variable, which may be Null.
string An optional, case-sensitive, pattern-matching string that identifies the name(s) of the session(s) whose information is to be returned to %persObjList. The default if no string is provided is to return the information of all sessions.

Usage notes

SessionList is also a shared method in the PersistentObjectInfo class. Consequently:

  • Both of these statements are valid:

    %persInfoList = %(object):sessionList %persInfoList = %(persistentObjectInfo):sessionList

  • You can use the Object class SessionList method the same way the the PersistentObjectInfo class GlobalList method is used in the example in Using GlobalList or SessionList.

Examples

See Using system class methods to access global and session objects.

See also