Recordset methods syntax: Difference between revisions
m (Automatically generated page update) |
m (Automatically generated page update) |
||
| Line 27: | Line 27: | ||
<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">%currentLockStrength</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[LoopLockStrength (Recordset property)|LoopLockStrength]]</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">%currentLockStrength</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[LoopLockStrength (Recordset property)|LoopLockStrength]]</span> | ||
<span class="term">recordset</span><span class="literal">:[[LoopLockStrength (Recordset property)|LoopLockStrength]]</span> <span class="literal">= </span><span class="term">newLockStrength</span></p> | <span class="term">recordset</span><span class="literal">:[[LoopLockStrength (Recordset property)|LoopLockStrength]]</span> <span class="literal">= </span><span class="term">newLockStrength</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"> =</span> <span class="literal">%(Recordset):[[New (Recordset constructor)|New]]</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">%recordset</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Recordset In </span><span class="term">filOrGrp name</span><span class="literal">)</span><span class="squareb">]</span><span class="literal">:[[New (Recordset constructor)|New]]</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> - | ||
<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">recordset</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">recordset</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">recordset</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">recordset</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> | ||
Revision as of 21:45, 22 August 2011
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( recordset)
%outRecordset = recordset:AddRecordsetNew( recordset)
recordset:AndRecordset( recordset)
%outRecordset = recordset:AndRecordsetNew( recordset)
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=] string, [Output=] string, - [[Report=] string], [[Parameters=] string], - [AllMessages= boolean], [Asynch= boolean], - [Notify= boolean], [MaxTime= number])
%fastUnloadTask = recordset:FastUnloadTask( [Input=] string, - [[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( recordset)
%outRecordset = recordset:RemoveRecordsetNew( recordset)
%string = recordset:ToString[( [MaxRecords= number])]