ReadLinesFromFile task

  • Article

Reads a list of items from a text file.

Parameters

The following table describes the parameters of the ReadLinesFromFile task.

Parameter Description
File Required ITaskItem parameter.

Specifies the file to read. The file must have one item on each line.
Lines Optional ITaskItem[] output parameter.

Contains the lines read from the file.

Remarks

In addition to the parameters listed above, this task inherits parameters from the TaskExtension class, which itself inherits from the Task class. For a list of these additional parameters and their descriptions, see TaskExtension base class.

Example

The following example uses the ReadLinesFromFile task to create items from a list in a text file. The items read from the file are stored in the ItemsFromFile item collection.

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

    <ItemGroup>
        <MyTextFile Include="Items.txt"/>
    </ItemGroup>

    <Target Name="ReadFromFile">
        <ReadLinesFromFile
            File="@(MyTextFile)" >
            <Output
                TaskParameter="Lines"
                ItemName="ItemsFromFile"/>
        </ReadLinesFromFile>
    </Target>

</Project>

See also