RecordFormat (Dataset property): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
| Line 3: | Line 3: | ||
This <var>RecordFormat</var> enumeration property indicates the physical record format | This <var>RecordFormat</var> enumeration property indicates the physical record format | ||
of the input or output blocks. | of the input or output blocks. | ||
It is only settable while the object is in the <var>Closed</var> state. | It is only settable while the object is in the <var>Closed</var> [[Dataset class#The DatasetState enumeration|state]]. | ||
An attempt to set it while the dataset is not closed results in request | An attempt to set it while the dataset is not closed results in request | ||
cancellation. | cancellation. | ||
==Syntax== | ==Syntax== | ||
{{Template:Dataset:RecordFormat syntax}} | {{Template:Dataset:RecordFormat syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 13: | Line 15: | ||
<td>A <var>[[RecordFormat enumeration|RecordFormat]]</var> enumeration variable to receive the value indicating the <var class="term>dataset</var> record format. | <td>A <var>[[RecordFormat enumeration|RecordFormat]]</var> enumeration variable to receive the value indicating the <var class="term>dataset</var> record format. | ||
</td></tr> | </td></tr> | ||
<tr><th>dataset</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> | ||
</td></tr> | |||
<tr><th>newRecordFormat</th> | <tr><th>newRecordFormat</th> | ||
<td>A <var>RecordFormat</var> enumeration variable to be used to set the <var class="term>dataset</var> object's record format. | <td>A <var>RecordFormat</var> enumeration variable to be used to set the <var class="term>dataset</var> object's record format.</td></tr> | ||
</td></tr></table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
| Line 24: | Line 27: | ||
<li><var>RecordFormat</var> is a bit of a misnomer in that it describes both the | <li><var>RecordFormat</var> is a bit of a misnomer in that it describes both the | ||
block and the record format. | block and the record format. | ||
<li>If <var>RecordFormat</var> is never set for a dataset before it is opened, the open | <li>If <var>RecordFormat</var> is never set for a dataset before it is opened, the open | ||
process will attempt to determine an appropriate record format for the | process will attempt to determine an appropriate record format for the | ||
dataset. | dataset. | ||
<li>For input datasets, the record format will usually be set from the input | <li>For input datasets, the record format will usually be set from the input | ||
file attributes, whether or not the <var>RecordFormat</var> property had been set. | file attributes, whether or not the <var>RecordFormat</var> property had been set. | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:Dataset:RecordFormat footer}} | {{Template:Dataset:RecordFormat footer}} | ||
Latest revision as of 23:36, 14 November 2012
The format of record i/o blocks (Dataset class)
This RecordFormat enumeration property indicates the physical record format
of the input or output blocks.
It is only settable while the object is in the Closed state.
An attempt to set it while the dataset is not closed results in request
cancellation.
Syntax
%currentRecordFormat = dataset:RecordFormat dataset:RecordFormat = newRecordFormat
Syntax terms
| %currentRecordFormat | A RecordFormat enumeration variable to receive the value indicating the dataset record format. |
|---|---|
| dataset | A reference to an instance of a Dataset object. |
| newRecordFormat | A RecordFormat enumeration variable to be used to set the dataset object's record format. |
Usage notes
- RecordFormat is a bit of a misnomer in that it describes both the block and the record format.
- If RecordFormat is never set for a dataset before it is opened, the open process will attempt to determine an appropriate record format for the dataset.
- For input datasets, the record format will usually be set from the input file attributes, whether or not the RecordFormat property had been set.