SessionList (PersistentObjectInfo function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Syntax terms) |
||
| Line 9: | Line 9: | ||
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared members|shared]] method. <var>SessionList</var> can also be invoked via a <var>PersistentObjectInfo</var> object variable, which may be <var>Null</var>.</td></tr> | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared members|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> | ||
<td>An optional, case-sensitive, pattern-matching | <td>An optional, case-sensitive, pattern-matching string that identifies the name(s) of the session(s) whose information is to be returned to <var class="term">%persObjList</var>. The default if no string is provided is to return information of all sessions.</td></tr> | ||
</table> | </table> | ||
Revision as of 23:41, 18 August 2011
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. |