NewFromSession (PersistentObjectInfo function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 7: | Line 7: | ||
<tr><th>%persObjInfo</th><td>A <var>PersistentObjectInfo</var> object variable.</td></tr> | <tr><th>%persObjInfo</th><td>A <var>PersistentObjectInfo</var> object variable.</td></tr> | ||
<tr><th><var>(PersistentObjectInfo)</var></th> | <tr><th><var>(PersistentObjectInfo)</var></th> | ||
<td> | <td>This optional specification of the class in parentheses denotes a [[Notation conventions for methods#Shared methods|virtual constructor]]. See [[#Usage notes|"Usage notes"]], below, for more information about invoking <var>NewFromSession</var>.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>A string that identifies the name of the session variable whose information is returned to <var class="term">%persObjList</var>.</td></tr> | <td>A string that identifies the name of the session variable whose information is returned to <var class="term">%persObjList</var>.</td></tr> | ||
Revision as of 19:05, 24 August 2011
Get info about session object (PersistentObjectInfo class)
[Introduced in Sirius Mods 7.8]
Syntax
%persObjInfo = [%(PersistentObjectInfo):]NewFromSession( name)
Syntax terms
| %persObjInfo | A PersistentObjectInfo object variable. |
|---|---|
| (PersistentObjectInfo) | This optional specification of the class in parentheses denotes a virtual constructor. See "Usage notes", below, for more information about invoking NewFromSession. |
| string | A string that identifies the name of the session variable whose information is returned to %persObjList. |
Usage notes
- Invoking NewFromSession if not in a session cancels the request.
- As described in "Virtual Constructor methods", NewFromSession can be invoked with
no method object, with an explicit class specification, or with an object variable of the class,
even if that object is Null:
%persObjInf = NewFromSession('EXCHG') %persObjInf = %(PersistentObjectInfo):NewFromSession('EXCHG') %persObjInf = %persObjInf:NewFromSession('EXCHG')