diff --git a/docs/xml/lazutils/lazstringutils.xml b/docs/xml/lazutils/lazstringutils.xml index 003c7ccbe8..a21d14db92 100644 --- a/docs/xml/lazutils/lazstringutils.xml +++ b/docs/xml/lazutils/lazstringutils.xml @@ -1281,6 +1281,85 @@ location where c was located. Maximum number of characters examined in the routine. + + +Writes the specified string value to the specified file name. + + +

+SaveStringToFile creates a TFileStream instance for the specified +file name, and writes the content in AString to the stream. The +stream is created with fmCreate mode. The Write method in the file stream is +used to store the value in AString. The return value is True if the +string value was successfully written to the stream instance. +

+

+Use LoadStringFromFile to read a string value from a file. +

+
+ +Added in LazUtils version 4.0. + + + +TFileStream + +
+ + +Returns True if the string was successfully written to the file. + + + + +String value stored in the routine. + + + + +File name where the string value is stored. + + + + + +Reads a string with the contents of the specified file name. + + +

+LoadStringFromFile creates a TFileStream instance used to load the +values from the file name in AFileName. The stream is created with +the fmOpenREad file mode, and its Read method is called to read the contents of +the entire file stream. +

+

+The return values is a String type with the values read from the stream, and +its size matches the size of the file stream. If the file stream has no +content, the return value is an empty string (''). +

+

+Use SaveStringToFile to store a string to a specified file name. +

+
+ +Added in LazUtils version 4.0. + + + +TFileStream + +
+ + +String with content read from the specified file name. + + + + +Qualified file name with the string value read in the routine. + + + Deprecated. Use SysUtils.IsValidIdent in RTL instead.