RecordFormat (Dataset property)

From m204wiki
Revision as of 22:23, 20 May 2011 by JAL2 (talk | contribs)
Jump to navigation Jump to search

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.

See also