company logo

FileHandle :: GetLine - Get a line of Text

The function reads the next line from a file. The returned string will not contain the newline character. The result string, which is passed in nstring will contain the text read. The result string might be an empty string, when a line does not contain relevant characters. When reaching end of file, the string contains a NULL value (isNull()).

FileHandle       fh;

// C++

fh.GetLine(result_string);

// OSI

result_string = fh.GetLine();

Notes:

In C++ the result string has to be passed as parameter. In OSI, the function is called without parameters.

Return value:  Success ( logical  )

Implementation details

logical FileHandle  :: GetLine ( NString &nstring )
  • nstring - String object