DiscardSessions (Object subroutine): Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Object:DiscardSessions subtitle}} | {{Template:Object:DiscardSessions subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:Object:DiscardSessions syntax}} | {{Template:Object:DiscardSessions 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>DiscardSessions</var> can also be invoked via | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared method]]. <var>DiscardSessions</var> can also be invoked via an <var>Object</var> class object variable, which may be <var>Null</var>.</td></tr> | ||
<tr><th>matchString</th> | <tr><th>matchString</th> | ||
<td>string</td></tr> | <td>A "wildcard" string that is applied to the set of session names. Objects referenced by session names matched by <var class="term">matchString</var> are discarded. | ||
<p> | |||
If the <var class="term">matchString</var> value is an asterisk (<tt>*</tt>), all objects referenced by session names are discarded.</p></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
If no session names matched by <var class="term">matchString</var> reference an object, this method does nothing. | |||
==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:DiscardSessions footer}} | {{Template:Object:DiscardSessions footer}} | ||
Latest revision as of 19:23, 7 August 2014
Discard session objects (Object class)
Syntax
%(Object):DiscardSessions( matchString)
Syntax terms
| %(Object) | The class name in parentheses denotes a shared method. DiscardSessions can also be invoked via an Object class object variable, which may be Null. |
|---|---|
| matchString | A "wildcard" string that is applied to the set of session names. Objects referenced by session names matched by matchString are discarded.
If the matchString value is an asterisk (*), all objects referenced by session names are discarded. |
Usage notes
If no session names matched by matchString reference an object, this method does nothing.
Examples
See Using system class methods to access global and session objects.