State (Dataset property): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Usage notes) |
||
| Line 19: | 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== | ==See also== | ||
{{Template:Dataset:State footer}} | {{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".