Extensions.File.WriteLine

Classification

Name	WriteLine
Short Description	Appends the specified string value followed by a line break to the file handle
Class	Action
Extension	OTX File extension
Group	File related Actions
Exceptions	FileAccessException FileFormatException FileLockException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

File.WriteLine(FileWriteHandleTerm, StringTerm);

Description

The WriteLine activity appends the specified string value followed by a line break to the file handle. The style of the line break shall be taken from the underlying operating system (Unix: '\n', Windows: '\r\n' or MacOS '\r').

The first read or write activity on a file handle defines if an access shall be realized by line, bytes or file. Mixed access will lead to a FileFormatException.

Properties

Name	Data Type	Class	Default	Cardinality	Description
handle	FileWriteHandle	Term	-	[1..1]	The handle for the file that the related file object encapsulates.
value	String	Term	-	[1..1]	The string to write to the file. The string can contain line breaks, which will be written without any operation system specific conversion.

OTL Examples

/// Local Declarations

File.FileWriteHandle FileWriteHandle1;

/// Flow

FileWriteHandle1 = File.OpenFileForWrite("file:///D:/abc/abc.txt", false, @Encoding:UTF-8);
File.WriteLine(FileWriteHandle1, "Hello\r\nWord");
File.WriteLine(FileWriteHandle1, "Hello Word");

See also

CloseFile
DeleteDirectory
DeleteFile
SaveFile
WriteBytes
WriteFile