• <GetStart>
  • CSPro User's Guide
    • The CSPro System
    • Data Dictionary Module
    • The CSPro Language
    • Data Entry Module
    • Batch Editing Applications
    • Tabulation Applications
    • Data Sources
    • CSPro Statements and Functions
      • Statement Format Symbols
      • Alphabetical List of Functions and Statements
      • List of Reserved Words
      • Deprecated Features
      • Declaration Statements
      • Symbol Functions
      • Item Functions
      • Array Object
      • Audio Object
      • Barcode and QR Codes
      • Case Object
      • Document Object
      • File Object
        • File Statement
        • File.open Function
        • File.close Function
        • File.read Function
        • File.write Function
      • Freq Object
      • Geometry Object
      • HashMap Object
      • Image Object
      • List Object
      • Map Object
      • Path
      • Pff Object
      • SystemApp Object
      • ValueSet Object
      • Program Control Statements
      • Assignment Statements
      • Data Entry Statements and Functions
      • Batch Edit Statements
      • Numeric Functions
      • String Functions
      • Multiple Occurrence Functions
      • General Functions
      • Date and Time Functions
      • External File Functions
      • Synchronization Functions
    • Templated Reporting System
    • HTML and JavaScript Integration
    • Action Invoker
    • Appendix
  • <CSEntry>
  • <CSBatch>
  • <CSTab>
  • <DataViewer>
  • <TextView>
  • <TblView>
  • <CSFreq>
  • <CSDeploy>
  • <CSPack>
  • <CSDiff>
  • <CSConcat>
  • <Excel2CSPro>
  • <CSExport>
  • <CSIndex>
  • <CSReFmt>
  • <CSSort>
  • <ParadataConcat>
  • <ParadataViewer>
  • <CSCode>
  • <CSDocument>
  • <CSView>
  • <CSWeb>

File.write Function

Format
b = file_handler.write(messageʃ, argument1, ..., argumentNʅ);
Description
The File.write function writes one or more lines of text to the File object associated with file_handler. This function is equivalent to the filewrite function.
The message is either a string expression or a numeric message number that contains the text that is written to the file. If the text contains any message formatters, the optional arguments argument1 to argumentN will be inserted into the text. There are some additional options for file output:
  • If you want to break a line of text into two lines, place '\n' (newline) where you want the line divided.
  • If you want a text line to begin on a new page, place '\f' (form feed) at the beginning of the text string.
  • If using the Original logic version, to output \n or \f as text instead of a new line or a new page, use a double backslash (e.g., "\\n").
Alternatively, the message can be a string List. If a List is provided, then each string contained in the List is written to the file, allowing for the output of multiple lines of text with one function call.
File text can also be written using the File.writeText and File.writeLines actions.
Return Value
The function returns a logical value of 1 (true) if successful and 0 (false) otherwise.
Example
File data_file_report;

data_file_report.
open("Data File Report.txt", create);

List string data_file_listing;
dirlist(data_file_listing, "Data", "*.csdb");

data_file_report.
write("There are %d files in the data directory:", data_file_listing.length());
data_file_report.
write("");
data_file_report.
write(data_file_listing);

data_file_report.
close();

view(filename(data_file_report));
See also: File Object, File.read Function, FileWrite Function, File.writeText Action, File.writeLines Action, Message Formatting Options, Encode Function