Object methods syntax: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
 
m (Automatically generated page update)
 
Line 2: Line 2:
     replaced, so any manual edits will be lost. You've been warned. -->
     replaced, so any manual edits will be lost. You've been warned. -->
{{Template:Syntax list header|class=Object}}
{{Template:Syntax list header|class=Object}}
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="literal">%(Object):[[DiscardGlobal (Object subroutine)|DiscardGlobal]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="term">object</span><span class="literal">:[[Audit (Object subroutine)|Audit]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Name=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Indent=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">MaxDepth=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span>          -
              <span class="squareb">[</span><span class="literal" title="Number">Truncate=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="String">Prefix=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">object</span><span class="literal">:[[ClassDescription (Object function)|ClassDescription]]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">object</span><span class="literal">:[[ClassName (Object function)|ClassName]]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[DiscardGlobal (Object subroutine)|DiscardGlobal]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[DiscardGlobals (Object subroutine)|DiscardGlobals]]</span><span class="literal">(</span> <span class="term" title="String">matchString</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[DiscardGlobals (Object subroutine)|DiscardGlobals]]</span><span class="literal">(</span> <span class="term" title="String">matchString</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[DiscardSession (Object subroutine)|DiscardSession]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[DiscardSession (Object subroutine)|DiscardSession]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="literal">)</span></p>
Line 10: Line 14:
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[GetSession (Object subroutine)|GetSession]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="term" title="Object">target</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[GetSession (Object subroutine)|GetSession]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="term" title="Object">target</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%persObjList</span><span class="literal"> =</span> <span class="literal">%(Object):[[GlobalList (Object function)|GlobalList]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">matchString</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%persObjList</span><span class="literal"> =</span> <span class="literal">%(Object):[[GlobalList (Object function)|GlobalList]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">matchString</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%object</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Object)</span><span class="squareb">]</span><span class="literal">:[[New (Object constructor)|New]]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%object</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Object):</span><span class="squareb">]</span><span class="literal">[[New (Object constructor)|New]]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[NullifyGlobal (Object subroutine)|NullifyGlobal]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[NullifyGlobal (Object subroutine)|NullifyGlobal]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[NullifyGlobals (Object subroutine)|NullifyGlobals]]</span><span class="literal">(</span> <span class="term" title="String">matchString</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[NullifyGlobals (Object subroutine)|NullifyGlobals]]</span><span class="literal">(</span> <span class="term" title="String">matchString</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[NullifySession (Object subroutine)|NullifySession]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[NullifySession (Object subroutine)|NullifySession]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[NullifySessions (Object subroutine)|NullifySessions]]</span><span class="literal">(</span> <span class="term" title="String">matchString</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[NullifySessions (Object subroutine)|NullifySessions]]</span><span class="literal">(</span> <span class="term" title="String">matchString</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">object</span><span class="literal">:[[ObjectId (Object function)|ObjectId]]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">object</span><span class="literal">:[[Print (Object subroutine)|Print]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Name=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Indent=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">MaxDepth=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span>          -
              <span class="squareb">[</span><span class="literal" title="Number">Truncate=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="String">Prefix=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%persObjList</span><span class="literal"> =</span> <span class="literal">%(Object):[[SessionList (Object function)|SessionList]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%persObjList</span><span class="literal"> =</span> <span class="literal">%(Object):[[SessionList (Object function)|SessionList]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[SetGlobal (Object subroutine)|SetGlobal]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="term" title="Object">source</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[SetGlobal (Object subroutine)|SetGlobal]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="term" title="Object">source</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[SetSession (Object subroutine)|SetSession]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="term" title="Object">source</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="literal">%(Object):[[SetSession (Object subroutine)|SetSession]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="term" title="Object">source</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">object</span><span class="literal">:[[Trace (Object subroutine)|Trace]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Name=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Indent=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">MaxDepth=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span>          -
              <span class="squareb">[</span><span class="literal" title="Number">Truncate=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="String">Prefix=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p>

Latest revision as of 02:48, 16 July 2012

The syntax for each of the Object class methods is shown below.

Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of Object methods.

object:Audit[( [Name= string], [Indent= number], [MaxDepth= number], - [Truncate= number], [Prefix= string])]

%string = object:ClassDescription

%string = object:ClassName

%(Object):DiscardGlobal( name)

%(Object):DiscardGlobals( matchString)

%(Object):DiscardSession( name)

%(Object):DiscardSessions( matchString)

%(Object):GarbageCollect

%(Object):GetGlobal( name, target)

%(Object):GetSession( name, target)

%persObjList = %(Object):GlobalList[( [matchString])]

%object = [%(Object):]New

%(Object):NullifyGlobal( name)

%(Object):NullifyGlobals( matchString)

%(Object):NullifySession( name)

%(Object):NullifySessions( matchString)

%number = object:ObjectId

object:Print[( [Name= string], [Indent= number], [MaxDepth= number], - [Truncate= number], [Prefix= string])]

%persObjList = %(Object):SessionList[( [string])]

%(Object):SetGlobal( name, source)

%(Object):SetSession( name, source)

object:Trace[( [Name= string], [Indent= number], [MaxDepth= number], - [Truncate= number], [Prefix= string])]