XenoGuard 4.0 Documentation

Read

ActionStep Reference » Windows » File » Read 

The ActionStep File Read scans the content of a text file and displays the text in a line placeholder.


[-] Hide
  1. Open the Windows node in the Workspace Explorer.
  2. Open the File node, select the Read ActionStep.

Parameters:

The ActionStep has the following input parameters:


name Description
Path Name
The path of the file where the content is to be retrieved.

Allowed Context Scopes
 [Fixed, Local, Global]
Allowed Context Types
 [Variable, Parameter, Enum]
Encoding
Specifies the character encoding to be used when reading the file.

Available character encoding schemes: ASCII, ANSI, UTF-8, UTF-8-BOM, Unicode

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]

Results:

The ActionStep returns the following results:


name
description
Line Count
The total number of lines in a file.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types 
[Variable, Parameter]
Lines
Contains the list of lines in a file and sets the content in line placeholders {0}.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter]

Example 1 (Read content of a file and store in a variable):

This example retrieves the content of the file per line and iterates through the list of lines. The content in each line placeholder is then stored in a local variable, Content, with the data type Text. The Value of the variable is then output in Write Text.


See other File operations: