State (Dataset property): Difference between revisions
Jump to navigation
Jump to search
m (Created page with "This <var>DatasetState enumeration</var> read/only property indicates the current state of the dataset. ==State syntax== <p class="pre"> %state = %dataset:state </p> ===Synta...") |
m (→Usage notes) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Dataset:State subtitle}} | |||
== | ==Syntax== | ||
{{Template:Dataset:State syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%datasetState</th> | ||
<td>A <var>DatasetState</var> enumeration variable to receive the value that indicates | <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. | ||
the current state of the dataset. | |||
</td></tr> | </td></tr> | ||
<tr><th> | <tr><th>dataset</th> | ||
<td>A reference to an instance of a <var>Dataset</var> object. | <td>A reference to an instance of a <var>Dataset</var> object. | ||
</td></tr></table> | </td></tr></table> | ||
==Usage | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The most common use for the <var>State</var> property is to check if end of file | <li>The most common use for the <var>State</var> property is to check if end of file | ||
| Line 21: | Line 19: | ||
<li>The initial state of all datasets is <var>Closed</var>. | <li>The initial state of all datasets is <var>Closed</var>. | ||
</ul> | </ul> | ||
==Example== | |||
For a simple example, see [[Dataset class#Dataset example|"Dataset example"]]. | |||
==See also== | |||
{{Template:Dataset:State footer}} | |||
Latest revision as of 00:21, 15 November 2012
The current state of this dataset (Dataset class)
Syntax
%datasetState = dataset:State
Syntax terms
| %datasetState | A DatasetState enumeration variable to receive the value that indicates the current state of the dataset object. |
|---|---|
| dataset | A reference to an instance of a Dataset object. |
Usage notes
- The most common use for the State property is to check if end of file
has been reached for an input dataset (
State=AfterEnd), or to check if an output file has filled (State=Full). - The initial state of all datasets is Closed.
Example
For a simple example, see "Dataset example".