WriteLinesToFile Class

Definition

Appends a list of items to a file. One item per line with carriage returns in-between.

This API supports the product infrastructure and is not intended to be used directly from your code.

public ref class WriteLinesToFile : Microsoft::Build::Tasks::TaskExtension
public ref class WriteLinesToFile : Microsoft::Build::Tasks::TaskExtension, Microsoft::Build::Framework::IIncrementalTask
public class WriteLinesToFile : Microsoft.Build.Tasks.TaskExtension
public class WriteLinesToFile : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.IIncrementalTask
type WriteLinesToFile = class
    inherit TaskExtension
type WriteLinesToFile = class
    inherit TaskExtension
    interface IIncrementalTask
Public Class WriteLinesToFile
Inherits TaskExtension
Public Class WriteLinesToFile
Inherits TaskExtension
Implements IIncrementalTask
Inheritance
WriteLinesToFile
Implements

Constructors

WriteLinesToFile()

This API supports the product infrastructure and is not intended to be used directly from your code.

Initializes a new instance of the WriteLinesToFile class.

Properties

BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

(Inherited from Task)
BuildEngine2

The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(Inherited from Task)
BuildEngine3

Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine4

Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine5

Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine6

Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine7

Retrieves the IBuildEngine7 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine8

Retrieves the IBuildEngine8 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine9

Retrieves the IBuildEngine9 version of the build engine interface provided by the host.

(Inherited from Task)
CanBeIncremental
Encoding

This API supports the product infrastructure and is not intended to be used directly from your code.

Encoding to be used.

FailIfNotIncremental

Question whether this task is incremental.

File

This API supports the product infrastructure and is not intended to be used directly from your code.

File to write lines to.

HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(Inherited from Task)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from Task)
Lines

This API supports the product infrastructure and is not intended to be used directly from your code.

Write each item as a line in the file.

Log

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(Inherited from TaskExtension)
Overwrite

This API supports the product infrastructure and is not intended to be used directly from your code.

If true, overwrite any existing file contents.

TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Inherited from Task)
WriteOnlyWhenDifferent

If true, the target file specified, if it exists, will be read first to compare against what the task would have written. If identical, the file is not written to disk and the timestamp will be preserved.

Methods

Execute()

This API supports the product infrastructure and is not intended to be used directly from your code.

Execute the task.

Applies to