TaskParameterEventArgs Class

Definition

Namespace:

Microsoft.Build.Framework

Assembly:

Microsoft.Build.Framework.dll

Package:

Microsoft.Build.Framework v17.11.4

Source:

TaskParameterEventArgs.cs

This class is used by tasks to log their parameters (input, output). The intrinsic ItemGroupIntrinsicTask to add or remove items also uses this class.

public ref class TaskParameterEventArgs : Microsoft::Build::Framework::BuildMessageEventArgs

public class TaskParameterEventArgs : Microsoft.Build.Framework.BuildMessageEventArgs

type TaskParameterEventArgs = class
    inherit BuildMessageEventArgs

Public Class TaskParameterEventArgs
Inherits BuildMessageEventArgs

Inheritance

EventArgs

BuildEventArgs

LazyFormattedBuildEventArgs

BuildMessageEventArgs

TaskParameterEventArgs

Constructors

TaskParameterEventArgs(TaskParameterMessageKind, String, IList, Boolean, DateTime)	Creates an instance of this class for the given task parameter.
TaskParameterEventArgs(TaskParameterMessageKind, String, String, String, IList, Boolean, DateTime)	Creates an instance of this class for the given task parameter.

Fields

locker

Lock object. (Inherited from LazyFormattedBuildEventArgs)

Properties

BuildEventContext	Event contextual information for the build event argument (Inherited from BuildEventArgs)
Code	Code associated with event. (Inherited from BuildMessageEventArgs)
ColumnNumber	Column number of interest in associated file. (Inherited from BuildMessageEventArgs)
EndColumnNumber	Ending column number of interest in associated file. (Inherited from BuildMessageEventArgs)
EndLineNumber	Ending line number of interest in associated file. (Inherited from BuildMessageEventArgs)
File	File associated with event. (Inherited from BuildMessageEventArgs)
HelpKeyword	Custom help keyword associated with event. (Inherited from BuildEventArgs)
Importance	Importance of the message (Inherited from BuildMessageEventArgs)
Items	The values being manipulated (added, removed, passed to/from task).
ItemType	The name of the item being manipulated, e.g. "Compile" if this is an item operation. If this object represents a task input, this property should be set to the same value as ParameterName for backward compatibility. Similarly, if this object represents a task output assigned to a property, this should be set to the same value as PropertyName for backward compatibility.
Kind	The kind of event represented by this instance.
LineNumber	Line number of interest in associated file. (Inherited from BuildMessageEventArgs)
LogItemMetadata	True if the Message string should include metadata.
Message
ParameterName	The name of the parameter if Kind is TaskInput or TaskOutput, null otherwise.
ProjectFile	The project which was building when the message was issued. (Inherited from BuildMessageEventArgs)
PropertyName	The name of the property if Kind is TaskOutput and the task output is assigned to a property, null otherwise.
RawMessage	Exposes the underlying message field without side-effects. Used for serialization. (Inherited from BuildEventArgs)
RawTimestamp	Exposes the private timestamp field to derived types. Used for serialization. Avoids the side effects of calling the Timestamp getter. (Inherited from BuildEventArgs)
SenderName	Name of the object sending this event. (Inherited from BuildEventArgs)
Subcategory	The custom sub-type of the event. (Inherited from BuildMessageEventArgs)
ThreadId	The thread that raised event. (Inherited from BuildEventArgs)
Timestamp	The time when event was raised. (Inherited from BuildEventArgs)