State (Dataset property)
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".