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 (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...") |
||
| Line 1: | Line 1: | ||
{{Template:Dataset:State subtitle}} | |||
This <var>[[DatasetState enumeration]]</var> read/only property indicates the current state | This <var>[[DatasetState enumeration]]</var> read/only property indicates the current state | ||
of the dataset. | of the dataset. | ||
== | ==Syntax== | ||
{{Template:Dataset:State syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 14: | Line 15: | ||
</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 22: | ||
<li>The initial state of all datasets is <var>Closed</var>. | <li>The initial state of all datasets is <var>Closed</var>. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:Dataset:State footer}} | |||
Revision as of 18:03, 20 May 2011
The current state of this dataset (Dataset class)
This DatasetState enumeration read/only property indicates the current state
of the dataset.
Syntax
%datasetState = dataset:State
Syntax terms
| %recfm | A DatasetState enumeration variable to receive the value that indicates
the current state of the dataset. |
|---|---|
| %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.