HELP
An object that allows the user to collect
records into a file.

USE
Use To DataSet to collect records that have
the same schema definition into a file for
later retrieval.  The following control pins
can be added:

* File Name -- This control pin allows the
user to change the name of the file that the
records will be written to.

* Rewind -- This control pin "rewinds" the
file and makes it available for rewriting
with an entirely new record type.  The effect
is the same as sending the first record to
the file with the Clear File At PreRun
selection checked.

LOCATION
I/O ==> To ==> DataSet

OPEN VIEW PARAMETERS
* To DataSet:  -- Click on the name field to
display a dialog box, then select the name of
the file that contains the DataSet.

* Clear File At PreRun -- If this box is
checked, the entire DataSet is cleared and
rewritten when To DataSet executes (when it
receives the first record).  Because the
DataSet is completely erased, records with a
new schema definition can be sent -- the
first record establishes the new schema
definition.

NOTES
The records going into the To DataSet file
must have the same schema (data shape and
type).  The first record written to the file
will define the schema that all subsequent
records must have.

Every time the To DataSet object executes
with its one input (only one input is
allowed), the new record is appended to the
file.  If the new record is an array, every
record element of it is appended.  The schema
(number of fields, and each field name, type,
and shape) must match for every record, but
the shape of the record (scalar/array) does
not matter.  The To DataSet object will
continue appending to the file until either a
Rewind control input is activated, or Clear
File At PreRun is checked True and PreRun
occurs.  The next time the To DataSet object
executes, it begins writing to the file at
its beginning, again starting with the schema
of the first record.  This schema may be
different than what was in the file.

SEE ALSO
Build Record, From DataSet, Record Constant,
and UnBuild Record.
