Previous (RecordsetCursor function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:RecordsetCursor:Previous subtitle}} | {{Template:RecordsetCursor:Previous 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>Previous may be issued if the cursor is in one of two states: | <li>Previous may be issued if the cursor is in one of two states: | ||
<ul> | <ul> | ||
<li><var>HasRecord</var> &mdash; Advances to the previous record (if there is one). | <li><var>HasRecord</var> &amp;mdash; Advances to the previous record (if there is one). | ||
<li><var>AfterEnd</var> &mdash; Advances to the last record. | <li><var>AfterEnd</var> &amp;mdash; 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 26: | Line 26: | ||
<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> &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>BeforeStart</var> &mdash; The cursor ran off the beginning, and it | <li><var>BeforeStart</var> &amp;mdash; The cursor ran off the beginning, and it | ||
points to no record. | points to no record. | ||
</ul> | </ul> | ||
Revision as of 19:40, 14 July 2011
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
| %cstate | If specified, a declared enumeration object of type CursorState to contain the state of the cursor after the completion of Previous. Valid values are described in "Cursor state". |
|---|---|
| %rscursor | An instantiated RecordsetCursor object. |
Usage notes
- Previous may be issued if the cursor is in one of two states:
- HasRecord &mdash; Advances to the previous record (if there is one).
- AfterEnd &mdash; 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 &mdash; The cursor moved to a new record, and it is ready to go.
- BeforeStart &mdash; The cursor ran off the beginning, and it points to no record.