LoopLockStrength (RecordsetCursor property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{Template:RecordsetCursor:LoopLockStrength subtitle}}
{{Template:RecordsetCursor:LoopLockStrength subtitle}}
This settable property contains a <var>LockStrength</var> enumeration
To indicate the minimum lock strength for records processed
that indicates the minimum lock strength for records processed
in <var>For Record At</var> loops on the <var>RecordsetCursor</var> object,
in <var>For Record At</var> loops on the <var>RecordsetCursor</var> object.
<var>LoopLockStrength</var> uses a <var>LockStrength</var> enumeration.
For more information, see
For more information, see
[[RecordsetCursor class#LoopLockStrength for RecordsetCursors|"LoopLockStrength for RecordsetCursors"]].
[[RecordsetCursor class#LoopLockStrength for RecordsetCursors|"LoopLockStrength for RecordsetCursors"]].

Revision as of 00:00, 27 April 2011

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 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