LoopLockStrength (RecordsetCursor property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 10: Line 10:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%ls</th>
<tr><th>%currentLockStrength</th>
<td>A declared enumeration object of type <var>LockStrength</var> to contain the returned value or to set the new value of ''%rscursor'''s minimum lock strength on records in a loop on ''%rscursor''.
<td>A declared enumeration 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)|"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)|"Cursor (Recordset constructor)"]].
</td></tr>
</td></tr>
<tr><th>%rscursor</th>
<tr><th>recordsetCursor</th>
<td>An instantiated <var>RecordsetCursor</var> object variable.
<td>An instantiated <var>RecordsetCursor</var> object variable.
<tr><th>newLockStrength</th>
<td>A declared enumeration object of type <var>LockStrength</var> 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 notes==
==Usage notes==
<ul>
<ul>

Revision as of 23:49, 26 April 2011

Set or return minimum lock strength of records in For Record At loops (RecordsetCursor class)


This settable property contains a LockStrength enumeration that indicates the minimum lock strength for records processed in For Record At loops on the RecordsetCursor object. For more information, see "LoopLockStrength for RecordsetCursors".

Syntax

%currentLockStrength = recordsetCursor:LoopLockStrength recordsetCursor:LoopLockStrength = newLockStrength

Syntax terms

%currentLockStrength A declared 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 An instantiated RecordsetCursor object variable.
newLockStrength A declared enumeration object of type LockStrength 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 only 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.
  • For more information about enumerations, see Enumerations.

See also