> Automation > Objects > Control Flow > Output File

Output File

Creates a file from a collection of data.



Input Parameters

Name Type Required Description
Data Link Yes

The data to be placed in a file, a collection, or example output from get services. Allowed data types are:

  • String
  • Number
  • Date
  • Array
File Name String Yes The name and path of the file to be created.
Width Number No The character width of the file with 80 being a common value.
Append Boolean Yes Enables the ability to append to an existing file, otherwise an existing file is overwritten.
Invoke Boolean Yes Start the file in the default program as determined by the file's extension.

Output Parameters

Name Type Description
Result Number Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name Type Required Example
Data Link Yes Link the Data field to any dropped Automation Object that produces a string, number, date, or array.
File Name Number Yes C:\folder1\file1.txt
Delimiter Character No <intentionally left blank>
Append Boolean No Optionally append to the file name specified if file already exists.
Invoke Boolean No Optionally invoke the specified file to be opened on the device.

Link the HTML object to this object in order to create an HTML file. The Invoke parameter will start the default browser.