RecordFormat (Dataset property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 10: | Line 10: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%currentRecordFormat</th> | ||
<td>A [[RecordFormat enumeration]] variable to receive the value indicating | <td>A <var>[[RecordFormat enumeration|RecordFormat]]</var> enumeration variable to receive the value indicating the <var class="term>dataset</var> record format. | ||
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> | |||
<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></tr></table> | </td></tr></table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
Revision as of 22:23, 20 May 2011
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.