Next (RecordsetCursor function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:RecordsetCursor:Next subtitle}} | {{Template:RecordsetCursor:Next subtitle}} | ||
This [[Notation conventions for methods#Callable | This [[Notation conventions for methods#Callable functions|callable]] | ||
method returns a <var>CursorState</var> enumeration | method returns a <var>CursorState</var> enumeration | ||
indicating the state of the cursor after it is moved. | indicating the state of the cursor after it is moved. | ||
| Line 19: | Line 19: | ||
<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 26: | Line 26: | ||
<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== | ==See also== | ||
{{Template:RecordsetCursor:Next footer}} | {{Template:RecordsetCursor:Next footer}} | ||
Revision as of 19:40, 14 July 2011
Move cursor to the next record in the set (RecordsetCursor class)
This callable method returns a CursorState enumeration indicating the state of the cursor after it is moved.
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.