Cursor (Recordset function): Difference between revisions
Jump to navigation
Jump to search
m (Created page with "<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> Cursor constructor <p> <var>Cursor</var> is a member of the <var...") |
m (→Syntax terms) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Recordset:Cursor subtitle}} | {{Template:Recordset:Cursor subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:Recordset:Cursor syntax}} | {{Template:Recordset:Cursor syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%recordsetCursor</th> | ||
<td> | <td>The result <var>[[RecordsetCursor class|RecordsetCursor]]</var> object, if the method object <var class="term>recordset</var> has at least one record. If <var class="term">recordset</var> has no records, <var>Cursor</var> returns a <var>Null</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th> | <tr><th>recordset</th> | ||
<td>A | <td>A <var>Recordset</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th>< | <tr><th><var>LoopLockStrength</var></th> | ||
<td>The lock strength to be used for <var>For Record At</var> loops on the cursor. This is an optional, [[Notation conventions for methods#Named parameters|name required]], parameter, available in <var class="product">Sirius Mods</var> 7.0 and later. It defaults to <var>None</var>. See [[RecordsetCursor#LoopLockStrength for RecordsetCursors|"LoopLockStrength for RecordsetCursors"]]. | <td>The lock strength to be used for <var>For Record At</var> loops on the cursor. This is an optional, [[Notation conventions for methods#Named parameters|name required]], parameter, available in <var class="product">Sirius Mods</var> 7.0 and later. It defaults to <var>None</var>. See [[RecordsetCursor class#LoopLockStrength for RecordsetCursors|"LoopLockStrength for RecordsetCursors"]]. | ||
</td></tr></table> | </td></tr></table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
Latest revision as of 19:54, 7 February 2012
Create a RecordsetCursor object from a Recordset (Recordset class)
Syntax
%recordsetCursor = recordset:Cursor[( [LoopLockStrength= lockStrength])]
Syntax terms
| %recordsetCursor | The result RecordsetCursor object, if the method object recordset has at least one record. If recordset has no records, Cursor returns a Null object. |
|---|---|
| recordset | A Recordset object. |
| LoopLockStrength | The lock strength to be used for For Record At loops on the cursor. This is an optional, name required, parameter, available in Sirius Mods 7.0 and later. It defaults to None. See "LoopLockStrength for RecordsetCursors". |
Usage notes
- You can have as many cursors as you want for a record set.
- To test for an empty record set, use IsEmpty, which is much more efficient than testing the record Count for 0,
- The instantiated RecordsetCursor is automatically positioned on the first record in the set.