SessionList (PersistentObjectInfo function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 10: | Line 10: | ||
<tr><th><var>(PersistentObjectInfo)</var></th> | <tr><th><var>(PersistentObjectInfo)</var></th> | ||
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>SessionList</var> can also be invoked via a <var>PersistentObjectInfo</var> object variable, which may be <var>Null</var>.</td></tr> | ||
<tr><th>matchString</th> | <tr><th>matchString</th> |
Revision as of 19:11, 27 August 2014
Get list of session objects (PersistentObjectInfo class)
[Introduced in Sirius Mods 7.8]
Syntax
%persObjList = %(PersistentObjectInfo):SessionList[( [matchString])]
Syntax terms
%persObjList | An 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
- SessionList is also a shared method in the Object class. This means that both of these statements are valid:
%persInfoList = %(persistentObjectInfo):sessionList %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.