Next (RecordsetCursor function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 1: Line 1:
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
{{Template:RecordsetCursor:Next subtitle}}
[[Category:RecordsetCursor methods|Next function]]
<p>
<var>Next</var> is a member of the <var>[[RecordsetCursor class|RecordsetCursor]]</var> class.
</p>


This [[Notation conventions for methods#Callable methods|callable]]
This [[Notation conventions for methods#Callable methods|callable]]
method positions the cursor on the &ldquo;next&rdquo; record in the set,
method positions the cursor on the &amp;ldquo;next&amp;rdquo; record in the set,
and it returns a <var>CursorState</var> enumeration
and it returns a <var>CursorState</var> enumeration
indicating the state of the cursor after the operation.
indicating the state of the cursor after the operation.
==Syntax==
==Syntax==
<p class="syntax">[%cstate =] %rscursor:Next
{{Template:RecordsetCursor:Next syntax}}
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 22: Line 17:
</td></tr></table>
</td></tr></table>


==Usage Notes==
==Usage notes==
<ul>
<ul>
<li>Next may be issued if the cursor is in one of two states:
<li>Next may be issued if the cursor is in one of two states:
<ul>
<ul>
<li><var>HasRecord</var> &mdash; Advances to the next record (if there is one).
<li><var>HasRecord</var> &amp;mdash; Advances to the next record (if there is one).
<li><var>BeforeStart</var> &mdash; Advances to the first record.
<li><var>BeforeStart</var> &amp;mdash; Advances to the first record.
</ul>
</ul>
<li>If <var>Next</var> is called on a cursor whose state is <var>AfterEnd</var>, the
<li>If <var>Next</var> is called on a cursor whose state is <var>AfterEnd</var>, the
Line 33: Line 28:
<li>After issuing <var>Next</var>, the cursor is left in one of two states:
<li>After issuing <var>Next</var>, the cursor is left in one of two states:
<ul>
<ul>
<li><var>HasRecord</var> &mdash; The cursor moved to a new record, and it is ready to go.
<li><var>HasRecord</var> &amp;mdash; The cursor moved to a new record, and it is ready to go.
<li><var>AfterEnd</var> &mdash; The cursor ran off the end, and it points to no record.
<li><var>AfterEnd</var> &amp;mdash; The cursor ran off the end, and it points to no record.
</ul>
</ul>
</ul>
</ul>
==See also==
{{Template:RecordsetCursor:Next footer}}

Revision as of 22:48, 26 April 2011

Move cursor to the next record in the set (RecordsetCursor class)


This callable method positions the cursor on the &ldquo;next&rdquo; record in the set, and it returns a CursorState enumeration indicating the state of the cursor after the operation.

Syntax

[%cursorState =] recordsetCursor:Next

Syntax terms

%cstate If specified, a declared enumeration object of type CursorState to contain the state of the cursor after the completion of Next. Valid values are described in "Cursor state".
%rscursor An instantiated RecordsetCursor object.

Usage notes

  • Next may be issued if the cursor is in one of two states:
    • HasRecord &mdash; Advances to the next record (if there is one).
    • BeforeStart &mdash; Advances to the first record.
  • If Next is called on a cursor whose state is AfterEnd, the request is cancelled.
  • After issuing Next, the cursor is left in one of two states:
    • HasRecord &mdash; The cursor moved to a new record, and it is ready to go.
    • AfterEnd &mdash; The cursor ran off the end, and it points to no record.

See also