Previous (RecordsetCursor function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:RecordsetCursor:Previous subtitle}} | {{Template:RecordsetCursor:Previous subtitle}} | ||
This [[Notation conventions for methods#Callable functions|callable]] | |||
method returns a <var>CursorState</var> enumeration | |||
indicating the [[RecordsetCursor class#Cursor state|state]] of the cursor after it is moved. | |||
==Syntax== | ==Syntax== | ||
{{Template:RecordsetCursor:Previous syntax}} | {{Template:RecordsetCursor:Previous 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>Previous</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>Previous may be issued if the cursor is in one of two states: | <li><var>Previous</var> may be issued if the cursor is in one of two states: | ||
<ul> | <ul> | ||
<li><var>HasRecord</var> & | <li><var>HasRecord</var> — Advances to the previous record (if there is one). | ||
<li><var>AfterEnd</var> & | <li><var>AfterEnd</var> — Advances to the last record. | ||
</ul> | </ul> | ||
<li>If <var>Previous</var> is called on a cursor whose state is <var>BeforeStart</var>, the | <li>If <var>Previous</var> is called on a cursor whose state is <var>BeforeStart</var>, the | ||
| Line 28: | Line 27: | ||
<li>After issuing <var>Previous</var>, the cursor is left in one of two states: | <li>After issuing <var>Previous</var>, the cursor is left in one of two states: | ||
<ul> | <ul> | ||
<li><var>HasRecord</var> & | <li><var>HasRecord</var> — The cursor moved to a new record, and it is ready to go. | ||
<li><var>BeforeStart</var> & | <li><var>BeforeStart</var> — The cursor ran off the beginning, and it | ||
points to no record. | points to no record. | ||
</ul> | </ul> | ||
Latest revision as of 21:02, 12 November 2012
Move cursor to the previous 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:Previous
Syntax terms
| %cursorState | An enumeration object of type CursorState to contain the state of the cursor after the completion of Previous. Valid values are described in "Cursor state". |
|---|---|
| recordsetCursor | A RecordsetCursor object. |
Usage notes
- Previous may be issued if the cursor is in one of two states:
- HasRecord — Advances to the previous record (if there is one).
- AfterEnd — Advances to the last record.
- If Previous is called on a cursor whose state is BeforeStart, the request is cancelled.
- After issuing Previous, the cursor is left in one of two states:
- HasRecord — The cursor moved to a new record, and it is ready to go.
- BeforeStart — The cursor ran off the beginning, and it points to no record.