SessionList (PersistentObjectInfo function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 31: Line 31:


==Examples==
==Examples==
See the <var>GlobalList</var> [[GlobalList (PersistentObjectInfo function)#Examples|examples]].
The <var>[[GlobalList (PersistentObjectInfo function)|GlobalList]]</var> method is for global objects what the
<var>SessionList</var> method is for session objects. See the <var>GlobalList</var> [[GlobalList (PersistentObjectInfo function)#Examples|examples]].


==See also==
==See also==
{{Template:PersistentObjectInfo:SessionList footer}}
{{Template:PersistentObjectInfo:SessionList footer}}

Revision as of 16:13, 19 August 2011

Get list of session objects (PersistentObjectInfo class)

[Introduced in Sirius Mods 7.8]


Syntax

%persObjList = %(PersistentObjectInfo):SessionList[( [matchString])]

Syntax terms

%persObjListAn Arraylist of Object PersistentObjectInfo object variable.
(PersistentObjectInfo) The class name in parentheses denotes a shared method. SessionList can also be invoked via a PersistentObjectInfo object variable, which may be Null.
matchString 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 information of all sessions.

Usage notes

  • SessionListis also a shared method in the Object class. This means that both of these statements are valid:

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

  • As a coding convenience, the PersistentObjectInfoList type is defined as an "Arraylist of Object PersistentObjectInfo". Consequently, instead of a declaration like this one:

    %persInfoList is arraylist of object persistentObjectInfo

    You can simply specify:

    %persInfoList is type persistentObjectInfoList

    Note: The keyword Type is required.

Examples

The GlobalList method is for global objects what the SessionList method is for session objects. See the GlobalList examples.

See also