NullifySession (Object subroutine): Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Object:NullifySession subtitle}} | {{Template:Object:NullifySession subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:Object:NullifySession syntax}} | {{Template:Object:NullifySession 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>NullifySession</var> can also be invoked via | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared method]]. <var>NullifySession</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 the session name that is to be nullified.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li><var>NullifySession</var> sets the object reference of the <var class="term">name</var> session name to Null, that is, referencing nothing. </li> | |||
<li>If the specified session name does not reference an object, this method does nothing. </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:NullifySession footer}} | {{Template:Object:NullifySession footer}} | ||
Revision as of 22:06, 12 August 2014
Clear session object reference (Object class)
Syntax
%(Object):NullifySession( name)
Syntax terms
| %(Object) | The class name in parentheses denotes a shared method. NullifySession can also be invoked via an Object class object variable, which may be Null. |
|---|---|
| name | A string that specifies the session name that is to be nullified. |
Usage notes
- NullifySession sets the object reference of the name session name to Null, that is, referencing nothing.
- If the specified session name does not reference an object, this method does nothing.
- If the specified session is not open, the request is cancelled.
Examples
See Using system class methods to access global and session objects.