Next (RecordsetCursor function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:RecordsetCursor:Next subtitle}} | {{Template:RecordsetCursor:Next subtitle}} | ||
This [[Notation conventions for methods#Callable functions|callable]] | This [[Notation conventions for methods#Callable functions|callable]] | ||
method returns a <var>CursorState</var> | method returns a <var>CursorState</var> <var>[[Enumerations|Enumeration]]</var> | ||
indicating the state of the cursor after it is moved. | indicating the [[RecordsetCursor class#Cursor state|state]] of the cursor after it is moved. | ||
==Syntax== | ==Syntax== | ||
{{Template:RecordsetCursor:Next syntax}} | {{Template:RecordsetCursor:Next syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%cursorState</th> | ||
<td> | <td>An enumeration object of type <var>CursorState</var> to contain the state of the cursor after the completion of <var>Next</var>. Valid values are described in [[RecordsetCursor class#Cursor state|"Cursor state"]].</td></tr> | ||
</td></tr> | |||
</td></tr></table> | <tr><th>recordsetCursor</th> | ||
<td>A <var>RecordsetCursor</var> object.</td></tr> | |||
</table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>Next may be issued if the cursor is in one of two states: | <li><var>Next</var> may be issued if the cursor is in one of two states: | ||
<ul> | <ul> | ||
<li><var>HasRecord</var> — Advances to the next record (if there is one). | <li><var>HasRecord</var> — Advances to the next record (if there is one). | ||
<li><var>BeforeStart</var> — Advances to the first record. | <li><var>BeforeStart</var> — 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 | ||
request is cancelled. | request is cancelled. | ||
<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> | ||
| Line 30: | Line 33: | ||
</ul> | </ul> | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:RecordsetCursor:Next footer}} | {{Template:RecordsetCursor:Next footer}} | ||
Latest revision as of 21:00, 12 November 2012
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
| %cursorState | An enumeration object of type CursorState to contain the state of the cursor after the completion of Next. Valid values are described in "Cursor state". |
|---|---|
| recordsetCursor | A RecordsetCursor object. |
Usage notes
- Next may be issued if the cursor is in one of two states:
- HasRecord — Advances to the next record (if there is one).
- BeforeStart — 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 — The cursor moved to a new record, and it is ready to go.
- AfterEnd — The cursor ran off the end, and it points to no record.