Cursor (Recordset function)

From m204wiki
Revision as of 17:22, 15 April 2011 by JAL2 (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

<section begin=dpl_desc/><section end=dpl_desc/>

Cursor is a member of the Recordset class.

Instantiates a RecordSetCursor object for a particular instance of a Recordset object.

Syntax

%rscursor = %rs:Cursor([LoopLockStrength=lockstrength])

Syntax Terms

%rscursor A declared RecordsetCursor object, to which Cursor returns an instance of a RecordsetCursor object, if %rs has at least one record. If %rs has no records, Cursor returns a Null object.
%rs A reference to an instance of a Recordset object.
LoopLockStrength=lockstrength 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.