Dataset methods syntax: Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
(Automatically generated page update) |
||
| Line 4: | Line 4: | ||
<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">%currentNumber</span><span class="literal"> =</span> <span class="term">dataset</span><span class="literal">:[[BlockSize (Dataset property)|BlockSize]]</span> | <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">%currentNumber</span><span class="literal"> =</span> <span class="term">dataset</span><span class="literal">:[[BlockSize (Dataset property)|BlockSize]]</span> | ||
<span class="term">dataset</span><span class="literal">:[[BlockSize (Dataset property)|BlockSize]]</span> <span class="literal">= </span><span class="term">newNumber</span></p> | <span class="term">dataset</span><span class="literal">:[[BlockSize (Dataset property)|BlockSize]]</span> <span class="literal">= </span><span class="term">newNumber</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">dataset</span><span class="literal">:[[Close (Dataset subroutine)|Close]]</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">dataset</span><span class="literal">:[[Close (Dataset subroutine)|Close]]</span> | ||
Throws [[WriteError class|WriteError]]</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">%dataset</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Dataset):</span><span class="squareb">]</span><span class="literal">[[New (Dataset constructor)|New]]</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">%dataset</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Dataset):</span><span class="squareb">]</span><span class="literal">[[New (Dataset constructor)|New]]</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">%currentNumber</span><span class="literal"> =</span> <span class="term">dataset</span><span class="literal">:[[NumberOfBuffers (Dataset property)|NumberOfBuffers]]</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="term">%currentNumber</span><span class="literal"> =</span> <span class="term">dataset</span><span class="literal">:[[NumberOfBuffers (Dataset property)|NumberOfBuffers]]</span> | ||
| Line 21: | Line 23: | ||
<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">%doc</span><span class="literal"> =</span> <span class="term">dataset</span><span class="literal">:[[SirTuneReport (Dataset function)|SirTuneReport]]</span><span class="literal">(</span> <span class="term" title="XmlDoc">doc</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">%doc</span><span class="literal"> =</span> <span class="term">dataset</span><span class="literal">:[[SirTuneReport (Dataset function)|SirTuneReport]]</span><span class="literal">(</span> <span class="term" title="XmlDoc">doc</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">%datasetState</span><span class="literal"> =</span> <span class="term">dataset</span><span class="literal">:[[State (Dataset property)|State]]</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">%datasetState</span><span class="literal"> =</span> <span class="term">dataset</span><span class="literal">:[[State (Dataset property)|State]]</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">dataset</span><span class="literal">:[[WriteBlock (Dataset subroutine)|WriteBlock]]</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">dataset</span><span class="literal">:[[WriteBlock (Dataset subroutine)|WriteBlock]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="literal">)</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="term">dataset</span><span class="literal">:[[WriteRecord (Dataset subroutine)|WriteRecord]]</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">dataset</span><span class="literal">:[[WriteRecords (Dataset subroutine)|WriteRecords]]</span><span class="literal">(</span> <span class="term" title="Stringlist">sl</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">From=</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">For=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p> | Throws [[WriteError class|WriteError]]</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">dataset</span><span class="literal">:[[WriteRecord (Dataset subroutine)|WriteRecord]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="literal">)</span> | |||
Throws [[WriteError class|WriteError]]</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">dataset</span><span class="literal">:[[WriteRecords (Dataset subroutine)|WriteRecords]]</span><span class="literal">(</span> <span class="term" title="Stringlist">sl</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">From=</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">For=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span> | |||
Throws [[WriteError class|WriteError]]</p> | |||
Latest revision as of 18:57, 5 August 2016
The syntax for each of the Dataset 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 Dataset methods.
%currentNumber = dataset:BlockSize dataset:BlockSize = newNumber
dataset:Close Throws WriteError
%dataset = [%(Dataset):]New( string)
%currentNumber = dataset:NumberOfBuffers dataset:NumberOfBuffers = newNumber
[%rc =] dataset:Open
%currentBoolean = dataset:Output dataset:Output = newBoolean
%string = dataset:ReadBlock
%string = dataset:ReadRecord
%sl = dataset:ReadRecords[( [Max= number], [Min= number])]
%currentRecordFormat = dataset:RecordFormat dataset:RecordFormat = newRecordFormat
%currentNumber = dataset:RecordLength dataset:RecordLength = newNumber
%doc = dataset:SirAudReport( doc)
%doc = dataset:SirTuneReport( doc)
%datasetState = dataset:State
dataset:WriteBlock( string) Throws WriteError
dataset:WriteRecord( string) Throws WriteError
dataset:WriteRecords( sl, [From= number], [For= number]) Throws WriteError