System methods syntax: Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
(Automatically generated page update) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
<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="literal">%(System):[[CallStackCaller (System function)|CallStackCaller]]</span><span class="literal">(</span> <span class="term" title="Number">number</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">%string</span><span class="literal"> =</span> <span class="literal">%(System):[[CallStackCaller (System function)|CallStackCaller]]</span><span class="literal">(</span> <span class="term" title="Number">number</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="literal">%(System):[[CallStackDepth (System function)|CallStackDepth]]</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="literal">%(System):[[CallStackDepth (System function)|CallStackDepth]]</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="literal">%(System):[[ClientCertificate (System function)|ClientCertificate]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="Boolean">RequestCertificate=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span> | |||
Throws [[NotJanusConnection class|NotJanusConnection]]</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="literal">%(System):[[ConnectionStartTimeMilliseconds (System function)|ConnectionStartTimeMilliseconds]]</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="literal">%(System):[[ConnectionStartTimeMilliseconds (System function)|ConnectionStartTimeMilliseconds]]</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="literal">%(System):[[ConnectionStartTimeString (System function)|ConnectionStartTimeString]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String"> | <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="literal">%(System):[[ConnectionStartTimeString (System function)|ConnectionStartTimeString]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">format</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span> | ||
Throws [[InvalidDateString class|InvalidDateString]]</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">%boolean</span><span class="literal"> =</span> <span class="literal">%(System):[[CurrentRecordIsUpdated (System function)|CurrentRecordIsUpdated]]</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">%boolean</span><span class="literal"> =</span> <span class="literal">%(System):[[CurrentRecordIsUpdated (System function)|CurrentRecordIsUpdated]]</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="literal">%(System):[[CurrentTimeDays (System function)|CurrentTimeDays]]</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="literal">%(System):[[CurrentTimeDays (System function)|CurrentTimeDays]]</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="literal">%(System):[[CurrentTimeMilliseconds (System function)|CurrentTimeMilliseconds]]</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="literal">%(System):[[CurrentTimeMilliseconds (System function)|CurrentTimeMilliseconds]]</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="literal">%(System):[[CurrentTimeSeconds (System function)|CurrentTimeSeconds]]</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="literal">%(System):[[CurrentTimeSeconds (System function)|CurrentTimeSeconds]]</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="literal">%(System):[[CurrentTimeString (System function)|CurrentTimeString]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">format</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="literal">%(System):[[CurrentTimeString (System function)|CurrentTimeString]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">format</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span> | ||
Throws [[InvalidDateString class|InvalidDateString]]</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">%(System):[[DeleteGlobal (System subroutine)|DeleteGlobal]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%(System):[[DeleteGlobal (System subroutine)|DeleteGlobal]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%(System):[[DeleteObject (System subroutine)|DeleteObject]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%(System):[[DeleteObject (System subroutine)|DeleteObject]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%(System):[[DeleteString (System subroutine)|DeleteString]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%(System):[[DeleteString (System subroutine)|DeleteString]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%privateKey</span><span class="literal"> =</span> <span class="literal">%(System):[[GeneratedPrivateKey (System function)|GeneratedPrivateKey]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">Length=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> - | |||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">Exponent=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> - | |||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Salt=</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="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(System):[[GetObject (System function)|GetObject]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="Object">object</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="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(System):[[GetObject (System function)|GetObject]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="Object">object</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">%string</span><span class="literal"> =</span> <span class="literal">%(System):[[LastSubsystemErrorFile (System function)|LastSubsystemErrorFile]]</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="literal">%(System):[[LastSubsystemErrorFile (System function)|LastSubsystemErrorFile]]</span></p> | ||
| Line 23: | Line 33: | ||
<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">%sl</span><span class="literal"> =</span> <span class="literal">%(System):[[ListOfObjects (System function)|ListOfObjects]]</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">%sl</span><span class="literal"> =</span> <span class="literal">%(System):[[ListOfObjects (System function)|ListOfObjects]]</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">%sl</span><span class="literal"> =</span> <span class="literal">%(System):[[ListOfStrings (System function)|ListOfStrings]]</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">%sl</span><span class="literal"> =</span> <span class="literal">%(System):[[ListOfStrings (System function)|ListOfStrings]]</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">%boolean</span><span class="literal"> =</span> <span class="literal">%(System):[[RecordIsUpdated (System function)|RecordIsUpdated]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="Number">number</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">%boolean</span><span class="literal"> =</span> <span class="literal">%(System):[[RecordIsUpdated (System function)|RecordIsUpdated]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="Number">number</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">%(System):[[SetGlobal (System subroutine)|SetGlobal]]</span><span class="literal">(</span> <span class="term" title="String"> | <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">%currentBoolean</span><span class="literal"> =</span> <span class="literal">%(System):[[RunSubsystemErrorProcedure (System property)|RunSubsystemErrorProcedure]]</span> | ||
<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="squareb">[</span><span class="term">% | <span class="literal">%(System):[[RunSubsystemErrorProcedure (System property)|RunSubsystemErrorProcedure]]</span> <span class="literal">= </span><span class="term">newBoolean</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="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(System):[[SetString (System function)|SetString]]</span><span class="literal">(</span> <span class="term" title="String"> | <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">%(System):[[SetGlobal (System subroutine)|SetGlobal]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="term" title="String">value</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">% | <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="squareb">[</span><span class="term">%gen</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(System):[[SetObject (System function)|SetObject]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="term" title="Object">object</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="Number">testGen</span><span class="squareb">]</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="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(System):[[SetString (System function)|SetString]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="term" title="String">value</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">oldValue</span><span class="squareb">]</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">%value</span><span class="literal"> =</span> <span class="literal">%(System):[[String (System function)|String]]</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="term">%string</span><span class="literal"> =</span> <span class="literal">%(System):[[TODClock (System function)|TODClock]]</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="literal">%(System):[[UUIDTime (System function)|UUIDTime]]</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="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(System):[[WakeupAt (System function)|WakeupAt]]</span><span class="literal">(</span> <span class="term" title="Number">timeInMilliseconds</span><span class="literal">)</span></p> | |||
Latest revision as of 16:16, 27 April 2015
The syntax for each of the System 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 System methods.
%string = %(System):Arguments
%sl = %(System):CallStack
%string = %(System):CallStackCaller( number)
%number = %(System):CallStackDepth
%string = %(System):ClientCertificate[( [RequestCertificate= boolean])] Throws NotJanusConnection
%number = %(System):ConnectionStartTimeMilliseconds
%string = %(System):ConnectionStartTimeString[( [format])] Throws InvalidDateString
%boolean = %(System):CurrentRecordIsUpdated
%number = %(System):CurrentTimeDays
%number = %(System):CurrentTimeMilliseconds
%number = %(System):CurrentTimeSeconds
%string = %(System):CurrentTimeString[( [format])] Throws InvalidDateString
%(System):DeleteGlobal( string)
%(System):DeleteObject( string)
%(System):DeleteString( string)
%privateKey = %(System):GeneratedPrivateKey[( [[Length=] number], - [[Exponent=] number], - [[Salt=] string])]
[%number =] %(System):GetObject( string, object)
%string = %(System):LastSubsystemErrorFile
%string = %(System):LastSubsystemErrorProcedure
%string = %(System):LastSubsystemErrorSubsystem
%sl = %(System):ListOfGlobals[( [string])]
%sl = %(System):ListOfObjects[( [string])]
%sl = %(System):ListOfStrings[( [string])]
%boolean = %(System):RecordIsUpdated( string, number)
%currentBoolean = %(System):RunSubsystemErrorProcedure %(System):RunSubsystemErrorProcedure = newBoolean
%(System):SetGlobal( name, value)
[%gen =] %(System):SetObject( name, object, [testGen])
[%number =] %(System):SetString( name, value, [oldValue])
%value = %(System):String( name)
%string = %(System):TODClock
%string = %(System):UUIDTime
[%number =] %(System):WakeupAt( timeInMilliseconds)