JCL Help:TWideStrings.SaveToStream
JCL Help: TWideStrings.SaveToStream Method
Search in JCL Help
Search in all projects
Summary
Writes the contents of the list to a stream.
Pascal
public procedure SaveToStream(Stream: TStream; WithBOM: Boolean = True); virtual;
Parameters
| Parameters | Description |
| Stream: TStream | TStream descendant to write the strings to. |
| WithBOM: Boolean = True | WithBOM determines whether to write a Byte Order Mark or not. Note: when saved as ANSI text there will never be a BOM. |
Description
SaveToStream writes the contents of the list to the specified stream. The individual strings are separated by a carriage-return linefeed pair. SaveToStream 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
SaveToFile 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
