JCL Help:TWideStrings.SaveToFile

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Saves the contents of the list to a file.


Pascal

 public procedure SaveToFile(const FileName: TFileName); virtual;


Parameters

Parameters Description
const FileName: TFileName Fully qualified name of the file to save the strings to.


Description

SaveToFile writes the contents of the list to the specified file. The individual strings are separated by a carriage-return linefeed pair. SaveToFile uses the value of the SaveUnicode property to determine whether to save the contents as Unicode or ANSI text. If SaveUnicode is False the text is saved as ANSI and in the process is implicitly converted using the systems locale. However, if there exists a potential information loss the user is notified through the OnConfirmConversion event. If SaveUnicode is True the text is saved as Unicode but is first prepended with the BOM_LSB_FIRST value to identify the text as Unicode appearing in with the least-significant-byte first byte-order mark.


See Also

SaveToStream OnConfirmConversion


About

Donator

Mike Lischke


Notes

Upon exit the Saved property is updated to reflect the result of the method.


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page