State (RecordsetCursor function) - Revision history

JAL at 21:06, 12 November 2012

2012-11-12T21:06:53Z

← Older revision		Revision as of 21:06, 12 November 2012
Line 2:		Line 2:
	==Syntax==		==Syntax==
	{{Template:RecordsetCursor:State syntax}}		{{Template:RecordsetCursor:State syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~cstate~~</th>		<tr><th>%cursorState</th>
	<td>~~If specified, a declared enumeration~~ object of type <var>CursorState</var> to contain the returned value of <var>State</var>. Possible values are <var>BeforeStart</var>, <var>HasRecord</var>, <var>AfterEnd</var>, <var>NoRecord</var>, and <var>Empty</var>, as described in [[RecordsetCursor class#Cursor state\|"Cursor state"]].		<td>An <var>[[Enumerations\|Enumeration]]</var> object of type <var>CursorState</var> to contain the returned value of <var>State</var>. Possible values are <var>BeforeStart</var>, <var>HasRecord</var>, <var>AfterEnd</var>, <var>NoRecord</var>, and <var>Empty</var>, as described in [[RecordsetCursor class#Cursor state\|"Cursor state"]].</td></tr>
	</td></tr>
	<tr><th>~~%rscursor~~</th>		<tr><th>recordsetCursor</th>
	<td>~~An instantiated~~ <var>RecordsetCursor</var> object.		<td>A <var>RecordsetCursor</var> object.

	</td></tr></table>		</td></tr></table>
	==Example==		==Example==

	The following fragment suggests a way to use the <var>State</var>		The following fragment suggests a way to use the <var>State</var>
	property with a cursor object:		property with a cursor object:
	<p class="code"> %rs is object recordSet in file myfile		<p class="code">%rs is object recordSet in file myfile
	%srecs is object SortedRecordset in file myfile		%srecs is object SortedRecordset in file myfile
	%myCursor is object RecordsetCursor in file myfile		%myCursor is object RecordsetCursor in file myfile
	...		...
	fd to %rs		fd to %rs
	end find		end find
	...		...
	sort records in %rs to %srecs by name		sort records in %rs to %srecs by name
	...		...
	%myCursor = %srecs:Cursor		%myCursor = %srecs:Cursor
	fr in %srecs		fr in %srecs
	...		...
	repeat while ( %myCursor:State = hasrecord )		repeat while ( %myCursor:State = hasrecord )
	end for		end for
	...		...
	</p>		</p>

	==See also==		==See also==
	{{Template:RecordsetCursor:State footer}}		{{Template:RecordsetCursor:State footer}}

JAL2 at 00:14, 27 April 2011

2011-04-27T00:14:48Z

← Older revision		Revision as of 00:14, 27 April 2011
Line 1:		Line 1:
	{{Template:RecordsetCursor:State subtitle}}		{{Template:RecordsetCursor:State subtitle}}

	==Syntax==		==Syntax==
	{{Template:RecordsetCursor:State syntax}}		{{Template:RecordsetCursor:State syntax}}

JAL2 at 00:14, 27 April 2011

2011-04-27T00:14:13Z

← Older revision		Revision as of 00:14, 27 April 2011
Line 1:		Line 1:
	{{Template:RecordsetCursor:State subtitle}}		{{Template:RecordsetCursor:State subtitle}}

	~~This [[Classes and Objects#readWrite\|read-only]] method returns the current state of the cursor.~~
	==Syntax==		==Syntax==
	{{Template:RecordsetCursor:State syntax}}		{{Template:RecordsetCursor:State syntax}}

JALWiccan: 1 revision

2011-04-26T22:48:40Z

1 revision

← Older revision	Revision as of 22:48, 26 April 2011
(No difference)

JAL2 at 22:48, 26 April 2011

2011-04-26T22:48:39Z

← Older revision		Revision as of 22:48, 26 April 2011
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}}

JAL2 at 22:41, 26 April 2011

2011-04-26T22:41:47Z

← Older revision		Revision as of 22:41, 26 April 2011
Line 1:		Line 1:
	<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>		<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
	[[Category:RecordsetCursor methods\|State ~~property~~]]		[[Category:RecordsetCursor methods\|State function]]
	<p>		<p>
	<var>State</var> is a member of the <var>[[RecordsetCursor class\|RecordsetCursor]]</var> class.		<var>State</var> is a member of the <var>[[RecordsetCursor class\|RecordsetCursor]]</var> class.
	</p>		</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		<p class="syntax">%cstate = %rscursor:State
Line 12:		Line 12:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%cstate</th>		<tr><th>%cstate</th>
	<td>If specified, a declared enumeration object of type <var>CursorState</var> to contain the returned value of <var>State</var>. Possible values are <var>BeforeStart</var>, <var>HasRecord</var>, <var>AfterEnd</var>, <var>NoRecord</var>, and <var>Empty</var>, as described in [[RecordsetCursor#Cursor state\|"Cursor state"]].		<td>If specified, a declared enumeration object of type <var>CursorState</var> to contain the returned value of <var>State</var>. Possible values are <var>BeforeStart</var>, <var>HasRecord</var>, <var>AfterEnd</var>, <var>NoRecord</var>, and <var>Empty</var>, as described in [[RecordsetCursor class#Cursor state\|"Cursor state"]].
	</td></tr>		</td></tr>
	<tr><th>%rscursor</th>		<tr><th>%rscursor</th>

JAL2: Created page with "
State property
`State` is a member of the
2011-04-22T18:17:08Z

Created page with "<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> State property <p> <var>State</var> is a member of the <va..."

New page
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:RecordsetCursor methods|State property]]
<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.
==Syntax==
<p class="syntax">%cstate = %rscursor:State
</p>
===Syntax terms===
<table class="syntaxTable">
<tr><th>%cstate</th>
<td>If specified, a declared enumeration object of type <var>CursorState</var> to contain the returned value of <var>State</var>. Possible values are <var>BeforeStart</var>, <var>HasRecord</var>, <var>AfterEnd</var>, <var>NoRecord</var>, and <var>Empty</var>, as described in [[RecordsetCursor#Cursor state|"Cursor state"]].
</td></tr>
<tr><th>%rscursor</th>
<td>An instantiated <var>RecordsetCursor</var> object.

</td></tr></table>
==Example==

The following fragment suggests a way to use the <var>State</var>
property with a cursor object:
<p class="code"> %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
...
</p>