State (RecordsetCursor function): Difference between revisions

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


This [[Classes and Objects#readWrite|read-only]] method returns the current state of the cursor.
This [[Classes and Objects#readWrite|read-only]] method returns the current state of the cursor.
==Syntax==
==Syntax==
<p class="syntax">%cstate = %rscursor:State
{{Template:RecordsetCursor:State syntax}}
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 38: Line 33:
   ...
   ...
</p>
</p>
==See also==
{{Template:RecordsetCursor:State footer}}

Revision as of 22:48, 26 April 2011

Return current state of RecordSetCursor (RecordsetCursor class)


This read-only method returns the current state of the cursor.

Syntax

%cursorState = recordsetCursor:State

Syntax terms

%cstate If specified, a declared enumeration object of type CursorState to contain the returned value of State. Possible values are BeforeStart, HasRecord, AfterEnd, NoRecord, and Empty, as described in "Cursor state".
%rscursor An instantiated RecordsetCursor object.

Example

The following fragment suggests a way to use the State property with a cursor object:

%rs is object recordSet in file myfile %srecs is object SortedRecordset in file myfile %myCursor is object RecordsetCursor in file myfile ... fd to %rs end find ... sort records in %rs to %srecs by name ... %myCursor = %srecs:Cursor fr in %srecs ... repeat while ( %myCursor:State = hasrecord ) end for ...

See also