Recordset methods syntax: Difference between revisions
m (Automatically generated page update) |
m (Automatically generated page update) |
||
| Line 14: | 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="term">%outRecordset</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[DeepCopy (Recordset function)|DeepCopy]]</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">:[[DeepCopy (Recordset function)|DeepCopy]]</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> | <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="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">recordset</span><span class="literal">:[[FastUnload (Recordset function)|FastUnload]]</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Input=</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="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">recordset</span><span class="literal">:[[FastUnload (Recordset function)|FastUnload]]</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Input=</span><span class="squareb">]</span> <span class="term" title="String">input</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="String">Output=</span><span class="squareb">]</span> <span class="term" title="String">output</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Report=</span><span class="squareb">]</span> <span class="term" title="String"> | <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Report=</span><span class="squareb">]</span> <span class="term" title="String">report</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Parameters=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean">AllMessages=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">Asynch=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="literal" title="Boolean">AllMessages=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">Asynch=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean">Notify=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">MaxTime=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p> | <span class="squareb">[</span><span class="literal" title="Boolean">Notify=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">MaxTime=</span> <span class="term" title="Number">number</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">%fastUnloadTask</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[FastUnloadTask (Recordset function)|FastUnloadTask]]</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Input=</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">%fastUnloadTask</span><span class="literal"> =</span> <span class="term">recordset</span><span class="literal">:[[FastUnloadTask (Recordset function)|FastUnloadTask]]</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Input=</span><span class="squareb">]</span> <span class="term" title="String">input</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Parameters=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Parameters=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean">AllMessages=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="literal" title="Boolean">AllMessages=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
Revision as of 21:02, 9 September 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=] 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( recordset)
%outRecordset = recordset:RemoveRecordsetNew( recordset)
%string = recordset:ToString[( [MaxRecords= number])]