Recordset methods syntax: Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
m (Automatically generated page update) |
||
| Line 3: | Line 3: | ||
{{Template:Syntax list header|class=Recordset}} | {{Template:Syntax list header|class=Recordset}} | ||
<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">recordset</span><span class="literal">:[[AddRecord (Recordset subroutine)|AddRecord]]</span><span class="literal">(</span> <span class="term" title="Record">record</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">recordset</span><span class="literal">:[[AddRecord (Recordset subroutine)|AddRecord]]</span><span class="literal">(</span> <span class="term" title="Record">record</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">recordset</span><span class="literal">:[[AddRecordset (Recordset subroutine)|AddRecordset]]</span><span class="literal">(</span> <span class="term" title="Recordset"> | <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">recordset</span><span class="literal">:[[AddRecordset (Recordset subroutine)|AddRecordset]]</span><span class="literal">(</span> <span class="term" title="Recordset">inRecordset</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">%outRecordset</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[AddRecordsetNew (Recordset function)|AddRecordsetNew]]</span><span class="literal">(</span> <span class="term" title="Recordset"> | <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">%outRecordset</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[AddRecordsetNew (Recordset function)|AddRecordsetNew]]</span><span class="literal">(</span> <span class="term" title="Recordset">inRecordset2</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">recordset</span><span class="literal">:[[AndRecordset (Recordset subroutine)|AndRecordset]]</span><span class="literal">(</span> <span class="term" title="Recordset"> | <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">recordset</span><span class="literal">:[[AndRecordset (Recordset subroutine)|AndRecordset]]</span><span class="literal">(</span> <span class="term" title="Recordset">recordset2</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">%outRecordset</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[AndRecordsetNew (Recordset function)|AndRecordsetNew]]</span><span class="literal">(</span> <span class="term" title="Recordset"> | <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">%outRecordset</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[AndRecordsetNew (Recordset function)|AndRecordsetNew]]</span><span class="literal">(</span> <span class="term" title="Recordset">recordset2</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">recordset</span><span class="literal">:[[Clear (Recordset subroutine)|Clear]]</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">recordset</span><span class="literal">:[[Clear (Recordset subroutine)|Clear]]</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">%outRecordset</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[Copy (Recordset function)|Copy]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</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">%outRecordset</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[Copy (Recordset function)|Copy]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</span> - | ||
| Line 30: | Line 30: | ||
<span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</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">recordset</span><span class="literal">:[[RemoveRecord (Recordset subroutine)|RemoveRecord]]</span><span class="literal">(</span> <span class="term" title="Record">record</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">recordset</span><span class="literal">:[[RemoveRecord (Recordset subroutine)|RemoveRecord]]</span><span class="literal">(</span> <span class="term" title="Record">record</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">recordset</span><span class="literal">:[[RemoveRecordset (Recordset subroutine)|RemoveRecordset]]</span><span class="literal">(</span> <span class="term" title="Recordset"> | <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">recordset</span><span class="literal">:[[RemoveRecordset (Recordset subroutine)|RemoveRecordset]]</span><span class="literal">(</span> <span class="term" title="Recordset">recordset2</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">%outRecordset</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[RemoveRecordsetNew (Recordset function)|RemoveRecordsetNew]]</span><span class="literal">(</span> <span class="term" title="Recordset"> | <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">%outRecordset</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[RemoveRecordsetNew (Recordset function)|RemoveRecordsetNew]]</span><span class="literal">(</span> <span class="term" title="Recordset">recordset2</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="term">recordset</span><span class="literal">:[[ToString (Recordset function)|ToString]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="Number">MaxRecords=</span> <span class="term" title="Number">number</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">recordset</span><span class="literal">:[[ToString (Recordset function)|ToString]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="Number">MaxRecords=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
Latest revision as of 19:27, 8 February 2012
The syntax for each of the Recordset 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 Recordset methods.
recordset:AddRecord( record)
recordset:AddRecordset( inRecordset)
%outRecordset = recordset:AddRecordsetNew( inRecordset2)
recordset:AndRecordset( recordset2)
%outRecordset = recordset:AndRecordsetNew( recordset2)
recordset:Clear
%outRecordset = recordset:Copy[( [lockStrength], - [LoopLockStrength= lockStrength])]
%number = recordset:Count
%recordsetCursor = recordset:Cursor[( [LoopLockStrength= lockStrength])]
%outRecordset = recordset:DeepCopy[( [lockStrength], - [LoopLockStrength= lockStrength])]
[%number =] recordset:FastUnload( [Input=] input, [Output=] output, - [[Report=] report], [[Parameters=] string], - [AllMessages= boolean], [Asynch= boolean], - [Notify= boolean], [MaxTime= number])
%fastUnloadTask = recordset:FastUnloadTask( [Input=] input, - [[Parameters=] string], - [AllMessages= boolean], - [ReportToStringlist= boolean], - [MaxTime= number])
%boolean = recordset:IsEmpty
%lockStrength = recordset:LockStrength
%currentLockStrength = recordset:LoopLockStrength recordset:LoopLockStrength = newLockStrength
%recordset = [%(Recordset In filOrGrp name):]New[( [lockStrength], - [LoopLockStrength= lockStrength])]
recordset:RemoveRecord( record)
recordset:RemoveRecordset( recordset2)
%outRecordset = recordset:RemoveRecordsetNew( recordset2)
%string = recordset:ToString[( [MaxRecords= number])]