View source for State (Dataset property)

{{Template:Dataset:State subtitle}}

==Syntax==
{{Template:Dataset:State syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%datasetState</th>
<td>A <var>[[DatasetState enumeration|DatasetState]]</var> enumeration variable to receive the value that indicates the current state of the <var class="term>dataset</var> object.
</td></tr>
<tr><th>dataset</th>
<td>A reference to an instance of a <var>Dataset</var> object.
 
</td></tr></table>
==Usage notes==
<ul>
<li>The most common use for the <var>State</var> property is to check if end of file
has been reached for an input dataset (<code>State=AfterEnd</code>), or to check if an
output file has filled (<code>State=Full</code>).
<li>The initial state of all datasets is <var>Closed</var>.
</ul>

==Example==
For a simple example, see [[Dataset class#Dataset example|"Dataset example"]].

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