GetSession (Object subroutine): Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Object:GetSession subtitle}} | {{Template:Object:GetSession subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:Object:GetSession syntax}} | {{Template:Object:GetSession syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th nowrap="true"><var>%(Object)</var></th> | <tr><th nowrap="true"><var>%(Object)</var></th> | ||
<td>The class name in parentheses denotes a shared method. <var>GetSession</var> can also be invoked via | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared method]]. <var>GetSession</var> can also be invoked via an <var>Object</var> class object variable, which may be <var>Null</var>.</td></tr> | ||
<tr><th>name</th> | <tr><th>name</th> | ||
<td>string</td></tr> | <td>A string that specifies a session name that references an object. </td></tr> | ||
<tr><th>target</th> | <tr><th>target</th> | ||
<td><var>Object</var> object</td></tr> | <td>An <var>Object</var> class object variable to be set by <var>GetSession</var> to reference the object referenced by the session name <var class="term">name</var>.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>If <var class="term">name</var> does not reference an object, <var>GetSession</var> sets <var class="term">target</var> to <var>Null</var>. </li> | |||
<li>If the specified session is not open, the request is cancelled.</li> | |||
</ul> | |||
==Examples== | ==Examples== | ||
See [[Global and session objects#Using system class methods to access global and session objects|Using system class methods to access global and session objects]]. | |||
==See also== | ==See also== | ||
{{Template:Object:GetSession footer}} | {{Template:Object:GetSession footer}} | ||
Latest revision as of 22:39, 8 August 2014
Retrieve session object reference (Object class)
Syntax
%(Object):GetSession( name, target)
Syntax terms
| %(Object) | The class name in parentheses denotes a shared method. GetSession can also be invoked via an Object class object variable, which may be Null. |
|---|---|
| name | A string that specifies a session name that references an object. |
| target | An Object class object variable to be set by GetSession to reference the object referenced by the session name name. |
Usage notes
- If name does not reference an object, GetSession sets target to Null.
- If the specified session is not open, the request is cancelled.
Examples
See Using system class methods to access global and session objects.