LoopLockStrength (RecordsetCursor property)

From m204wiki
Revision as of 23:20, 10 October 2014 by JAL (talk | contribs) (→‎Syntax terms)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.

See also