This function is used write a text file logging various information. In stepwise execution mode a single file will be written containing the information for all selected files. Also, when run stepwise, any variables referenced in the supplied strings are taken from the first selected file and a relative path (./) or (../) is relative to that same file.
The supplied output path field may contain any of the escape sequences described in Escape Sequences. The resultant file path may be absolute (/), relative to the Home folder (~/) or relative to the track's containing folder (./) or (../). Any path which does not exist or is invalid is ignored. Tip: while batch processing, if the output filename resolves to be empty, the logged data will be written to the batch log.
If the path to the file to be written does not exist, it will be created.
The following choices are available for what gets logged.
- Text
- will log all of the current tag information.
- Raw Data
- will log what is known about the raw structure of the file as it currently appears on disk.
- Text & Raw Data
- is equivalent to doing both of the above.
- Changes
- itemize everything that has changed.
- Validation Errors
- will log places where the contents of the tag information do not live up to the strict requirements of the specifications.
If the log data is successfully written, the action test state will be set to true. If the file is not successfully written, the action test state will be set to false.