Extensions.File.IsEndOfFileReached

From emotive
Jump to navigation Jump to search

Classification

Name IsEndOfFileReached
Short Description Checks whether the End-Of-File has been reached
Class Term
Extension OTX File extension
Group File related Terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm File.IsEndOfFileReached(FileReadHandleTerm handle);

Description

The IsEndOfFileReached activity checks If the End-Of-File has been reached by the ReadLine or ReadBytes term or if the file is empty, the term returns TRUE, otherwise FALSE.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Boolean Returns TRUE If the End-Of-File has been reached by the ReadLine or ReadBytes term or if the file is empty, otherwise FALSE.

Properties

Name Data Type Class Default Cardinality Description
Handle FileReadHandle Term - [1..1] The handle for the file that the related file object encapsulates.

OTL Examples

/// Local Declarations

Boolean Boolean1 = false;
File.FileReadHandle FileReadHandle1;

/// Flow

FileReadHandle1 = File.OpenFileForRead("file:///D:/abc.txt", @Encoding:UTF-8);
Boolean1 = File.IsEndOfFileReached(FileReadHandle1);

See also

CreateTempDirectory
GetFilePath
GetFilesFromDirectory
GetFileSize
IsDirectory
IsFile
OpenFileForRead
OpenFileForWrite
ReadBytes
ReadFile
ReadLine