LoopLockStrength (RecordsetCursor property): 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> LoopLockStrength property <p> <var>LoopLockStrength</var> ...") |
m (→Syntax terms) |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
< | {{Template:RecordsetCursor:LoopLockStrength subtitle}} | ||
To indicate the minimum lock strength for records processed | |||
< | in <var>For Record At</var> loops on the <var>RecordsetCursor</var> object, | ||
<var> | <var>LoopLockStrength</var> uses a <var>LockStrength</var> <var>[[Enumerations|Enumeration]]</var>. | ||
For more information, see | |||
[[RecordsetCursor class#LoopLockStrength for RecordsetCursors|"LoopLockStrength for RecordsetCursors"]]. | |||
==Syntax== | ==Syntax== | ||
{{Template:RecordsetCursor:LoopLockStrength syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%currentLockStrength</th> | ||
<td> | <td>An <var>Enumeration</var> object of type <var>LockStrength</var> to contain the returned value of <var class="term">recordsetCursor</var>'s minimum lock strength on records in a loop on <var class="term">recordsetCursor</var>. | ||
The enumeration values (shared properties) that may be returned (<var>None</var>, <var>Share</var>, or <var>Exclusive</var>), correspond to standard <var class="product">Model 204</var> record-locking levels, as described in [[Cursor (Recordset constructor) | The enumeration values (shared properties) that may be returned (<var>None</var>, <var>Share</var>, or <var>Exclusive</var>), correspond to standard <var class="product">Model 204</var> record-locking levels, as described in [[Cursor (Recordset constructor)]].</td></tr> | ||
</td></tr> | |||
<tr><th>recordsetCursor</th> | |||
<td>A <var>RecordsetCursor</var> object variable. | |||
<tr><th>newLockStrength</th> | |||
<td>A <var>LockStrength</var> enumeration to assign as the minimum lock strength on records in a loop on <var class="term">recordsetCursor</var>. | |||
The possible enumeration values are the same as those described above for <var class="term">%currentLockStrength</var>. | |||
</td></tr></table> | </td></tr></table> | ||
==Usage | |||
==Usage notes== | |||
<ul> | <ul> | ||
<li>This property is | <li>This property is available in <var class="product">Sirius Mods</var> 7.0 and later. | ||
<li>This property may only be set for cursors on <var>Recordset</var> objects. | <li>This property may only be set for cursors on <var>Recordset</var> objects. | ||
An attempt to set it for a cursor on a <var>SortedRecordset</var> object will | An attempt to set it for a cursor on a <var>SortedRecordset</var> object will | ||
result in request cancellation. | result in request cancellation. | ||
<li>If the returned locking value is assigned to an enumeration variable, | <li>If the returned locking value is assigned to an enumeration variable, | ||
use the [[ToString]] enumeration method. | use the <var>[[Enumerations#ToString property|ToString]]</var> enumeration method. | ||
to print the value string. | to print the value string. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:RecordsetCursor:LoopLockStrength footer}} | |||
Latest revision as of 23:20, 10 October 2014
Set or return minimum lock strength of records in For Record At loops (RecordsetCursor class)
To indicate the minimum lock strength for records processed in For Record At loops on the RecordsetCursor object, LoopLockStrength uses a LockStrength Enumeration. For more information, see "LoopLockStrength for RecordsetCursors".
Syntax
%currentLockStrength = recordsetCursor:LoopLockStrength recordsetCursor:LoopLockStrength = newLockStrength
Syntax terms
| %currentLockStrength | An Enumeration object of type LockStrength to contain the returned value of recordsetCursor's minimum lock strength on records in a loop on recordsetCursor. The enumeration values (shared properties) that may be returned (None, Share, or Exclusive), correspond to standard Model 204 record-locking levels, as described in Cursor (Recordset constructor). |
|---|---|
| recordsetCursor | A RecordsetCursor object variable. |
| newLockStrength | A LockStrength enumeration to assign as the minimum lock strength on records in a loop on recordsetCursor.
The possible enumeration values are the same as those described above for %currentLockStrength. |
Usage notes
- This property is available in Sirius Mods 7.0 and later.
- This property may only be set for cursors on Recordset objects. An attempt to set it for a cursor on a SortedRecordset object will result in request cancellation.
- If the returned locking value is assigned to an enumeration variable, use the ToString enumeration method. to print the value string.