File.ReadLines

method · File · cAlgo.API Since 5.7

DesktopCLICloud

Reads the lines of file.

Environment behaviour

Cloud — not supported. Exists returns false; reads return empty string/array; writes and appends silently do nothing. No exception.

Overloads

Signature	Description
`ReadLines()`	Reads the lines of file.
`ReadLines(EncodingType encodingType)`	Reads the lines of file that has a specified encoding.

ReadLines()

Reads the lines of file.

C#Python

string[] ReadLines()

file.ReadLines() -> list[str]

Returns string[]

Examples

C#Pythonconfig.json

protected override void OnStart()
{
    foreach (var line in DataFile.ReadLines())
        Print(line);
}

for line in api.DataFile.ReadLines():
    api.Print(line)

{
  "Parameters": [
    {
      "Name": "DataFile",
      "DisplayName": "Data File",
      "Type": "File"
    }
  ]
}

ReadLines(EncodingType encodingType)

Reads the lines of file that has a specified encoding.

C#Python

string[] ReadLines(EncodingType encodingType)

file.ReadLines(encodingType: EncodingType) -> list[str]

Parameters

Name	C# type	Python type	Description
`encodingType`	`EncodingType`	`EncodingType`	Encoding type

Returns string[]

Examples

C#Pythonconfig.json

protected override void OnStart()
{
    var lines = DataFile.ReadLines(EncodingType.Unicode);
    Print("{0} has {1} lines", DataFile.Name, lines.Length);
}

lines = api.DataFile.ReadLines(EncodingType.Unicode)
api.Print(f"{api.DataFile.Name} has {len(lines)} lines")

{
  "Parameters": [
    {
      "Name": "DataFile",
      "DisplayName": "Data File",
      "Type": "File"
    }
  ]
}