put_in_text_file

The function put_in_text_file writes produced text to a file. The text saved in this way will not appear in the result document. It is possible to call this function several times in a model. Each time you do this the text produced up to the call is placed in the file. This function produces an ASCII document regardless of the word processor the model document has been made with.

put_in_text_file ( "textfile_to_be_produced"; 
                   "path/folder_of_the_text_file";
                   "overwrite Y/N"; 
                   "pagination (ignored)";
                   "process_includes Y/N" ) 

The function returns a TEXT; the name of the file produced.

The put_in_text_file requires five parameters:

1. textfile_to_be_produced, type TEXT. The name of the document.
2. path/folder_of_the_text_file, type TEXT. The path and name of the folder or folder in which the text file will be written.
3. overwrite, type TEXT, Y or N. When you set this parameter to Y an already existing file is overwritten, when you set this parameter to N the end user will be prompted to specify an alternative filename/folder. Note that this will cause problems in an ITP/Server environment since ITP/Server cannot interact with the end user.
4. pagination, type TEXT, Y or N. The value of this parameter is ignored.
5. process_includes, type TEXT, Y or N. When set to Y ITP resolves __INC post includes in the result document. When you have enabled the check box Process includes on the Run tab of the ITP administration program, ITP will always resolve post includes.

The put_in_text_file function writes the ITP output to a text file, and does not create a copy. Once written to a file the output is no longer available for the ITP Model and it will not appear in the result document. The reason for this is that ITP stores text that is produced in an internal buffer. When you call the put_in_text_file function ITP writes the content of the buffer to the file, this clears the internal buffer.

If you want to create multiple files from one output you can use the open buffer mechanism.

Documents that ITP produces through the put_in_text_file( ) function are directly available for opening after ITP successfully executed the function put_in_text_file.

Note

The ASCII result document will also contain word processor instructions such as text-boxes, fields and footnotes. This might produce unexpected results because no attempt is made to maintain the layout of the output document. Therefore we advise you to avoid the use of word processor instructions that will appear in result documents when the put_in_text_file function is used.

Example

#
This line will be stored in the file 'file.txt' on c:\temp, and will not appear in the result document.
#
TEXT doc := put_in_text_file("file.txt"; "c:\temp"; "Y"; "N"; "N")
#
The file produced is @(doc). 
These lines will appear in the result document because they are produced after the put_in_text_file call above.
#