Difference between revisions of "WriteTextFile"

m
m (WriteTextFile(filename, text, append, warn, sep, showDialog, encoding))
Line 6: Line 6:
 
== WriteTextFile(filename, text'', append, warn, sep, showDialog, encoding'') ==
 
== WriteTextFile(filename, text'', append, warn, sep, showDialog, encoding'') ==
  
Writes «text» value to a file with name «filename».
+
Write  «text» value to a file with name «filename».
  
 
=== Optional parameters ===
 
=== Optional parameters ===
  
«append»: (Default  <code>False</code>.) If the file exists and «append» is <code>True</code>, it appends the text to the end of the file. If it doesn't exist, it asks whether to create the file. If «append» is <code>False</code>, and the file exists, and «warn» is <code>True</code>, it gives a warning to ask if you want to overwrite the file.
+
«append»: Default  <code>False</code>. If the file exists and «append» is <code>True</code>, it appends the text to the end of the file. If it doesn't exist and «warn» is <code>True</code> , it asks whether to create the file.  
  
«warn»: (Default  <code>True</code>.) If «warn» is <code>False</code>, it suppresses the warning that the file already exists when «append»is false or that it does not exist when «append»is True.
+
«warn»: Default  <code>True</code>.  If «warn» is <code>False</code>, it suppresses the warning that the file already exists when «append» is false or that it does not exist when «append» is True.
  
«showDialog»: (Default  <code>Undefined</code> -- it shows a file browser dialog only if the indicated filename is a folder, a read-only file, or if it exists and «warn» is <code>True</code>.  When «showDialog» is <code>True</code>,  it always opens a dialog before with file name as the default to let the user change file name or folder.  When <code>False</code>,  it never shows a dialog but may generate an error when trying to overwrite an existing file with «append» False.
+
«showDialog»: Default  <code>Undefined</code> -- i.e.  it shows a file browser dialog only if the indicated filename is a folder, a read-only file, or if it exists and «warn» is <code>True</code>, or if it does not exist and «append» is <code>True</code>.  When «showDialog» is <code>True</code>,  it always opens a dialog before with file name as the default to let the user change file name or folder.  When <code>False</code>,  it never shows a dialog but may generate an error when trying to overwrite an existing file with «append» False.
  
 
«sep»:  (Default is a new line.) Character to use as a separator between elements when «text» is an array.   
 
«sep»:  (Default is a new line.) Character to use as a separator between elements when «text» is an array.   
  
«encoding» (Default <code>"ANSI"</code>.) Specifies how to encode characters in the file:
+
«encoding» (Default <code>"ANSI"</code>.) Specifies how to encode characters in the file:
 
* <code>"ANSI"</code> : One byte per character, [http://en.wikipedia.org/wiki/8859 ISO-8859-1]. Extended characters (above ascii 255) are written as ?.
 
* <code>"ANSI"</code> : One byte per character, [http://en.wikipedia.org/wiki/8859 ISO-8859-1]. Extended characters (above ascii 255) are written as ?.
 
* <code>"UTF-8"</code> : [http://en.wikipedia.org/wiki/UTF-8 UTF-8 encoding] with a [http://en.wikipedia.org/wiki/Byte_order_mark byte order mark] ([http://en.wikipedia.org/wiki/Byte_order_mark BOM]). The UTF-8 encoding uses one byte for comman characters, and 2-3 bytes for characters with ascii values above 127.
 
* <code>"UTF-8"</code> : [http://en.wikipedia.org/wiki/UTF-8 UTF-8 encoding] with a [http://en.wikipedia.org/wiki/Byte_order_mark byte order mark] ([http://en.wikipedia.org/wiki/Byte_order_mark BOM]). The UTF-8 encoding uses one byte for comman characters, and 2-3 bytes for characters with ascii values above 127.

Revision as of 19:48, 24 August 2020


WriteTextFile(filename, text, append, warn, sep, showDialog, encoding)

Write «text» value to a file with name «filename».

Optional parameters

«append»: Default False. If the file exists and «append» is True, it appends the text to the end of the file. If it doesn't exist and «warn» is True , it asks whether to create the file.

«warn»: Default True. If «warn» is False, it suppresses the warning that the file already exists when «append» is false or that it does not exist when «append» is True.

«showDialog»: Default Undefined -- i.e. it shows a file browser dialog only if the indicated filename is a folder, a read-only file, or if it exists and «warn» is True, or if it does not exist and «append» is True. When «showDialog» is True, it always opens a dialog before with file name as the default to let the user change file name or folder. When False, it never shows a dialog but may generate an error when trying to overwrite an existing file with «append» False.

«sep»: (Default is a new line.) Character to use as a separator between elements when «text» is an array.

«encoding» (Default "ANSI".) Specifies how to encode characters in the file:

  • "ANSI" : One byte per character, ISO-8859-1. Extended characters (above ascii 255) are written as ?.
  • "UTF-8" : UTF-8 encoding with a byte order mark (BOM). The UTF-8 encoding uses one byte for comman characters, and 2-3 bytes for characters with ascii values above 127.
  • "-UTF-8" : UTF-8 encoding without a BOM.
  • "UTF-16" : Two bytes per character, big endian, with BOM.
  • "UTF-16le" : Two bytes per character, little endian, with BOM.

History

Introduced in Analytica 4.0.

«encoding» parameter introduced in Analytica 4.5.

See also

Comments


You are not allowed to post comments.