4 <name>Microsoft.Build.Framework</name>
7 <member name="T:Microsoft.Build.Shared.MSBuildConstants">
9 Constants that we want to be shareable across all our assemblies.
12 <member name="F:Microsoft.Build.Shared.MSBuildConstants.ToolsPath">
14 The name of the property that indicates the tools path
17 <member name="F:Microsoft.Build.Shared.MSBuildConstants.ToolsPath64">
19 Name of the property that indicates the X64 tools path
22 <member name="F:Microsoft.Build.Shared.MSBuildConstants.SdksPath">
24 Name of the property that indicates the root of the SDKs folder
27 <member name="F:Microsoft.Build.Shared.MSBuildConstants.TreatWarningsAsErrors">
29 Name of the property that indicates that all warnings should be treated as errors.
32 <member name="F:Microsoft.Build.Shared.MSBuildConstants.WarningsAsErrors">
34 Name of the property that indicates a list of warnings to treat as errors.
37 <member name="F:Microsoft.Build.Shared.MSBuildConstants.WarningsAsMessages">
39 Name of the property that indicates the list of warnings to treat as messages.
42 <member name="F:Microsoft.Build.Shared.MSBuildConstants.CurrentVisualStudioVersion">
44 The most current Visual Studio Version known to this version of MSBuild.
47 <member name="F:Microsoft.Build.Shared.MSBuildConstants.CurrentToolsVersion">
49 The most current ToolsVersion known to this version of MSBuild.
52 <member name="F:Microsoft.Build.Shared.MSBuildConstants.CurrentToolsVersionAsVersion">
54 The most current ToolsVersion known to this version of MSBuild as a Version object.
57 <member name="F:Microsoft.Build.Shared.MSBuildConstants.CurrentAssemblyVersion">
59 The most current VSGeneralAssemblyVersion known to this version of MSBuild.
62 <member name="P:Microsoft.Build.Shared.MSBuildConstants.CurrentProductVersion">
64 Current version of this MSBuild Engine assembly in the form, e.g, "12.0"
67 <member name="T:Microsoft.Build.Shared.ItemMetadataNames">
69 Constants naming well-known item metadata.
72 <member name="T:Microsoft.Build.Framework.BuildEngineResult">
74 This structure is used to return the result of the build and the target outputs.
77 <member name="F:Microsoft.Build.Framework.BuildEngineResult.buildResult">
79 Did the build pass or fail
82 <member name="F:Microsoft.Build.Framework.BuildEngineResult.targetOutputsPerProject">
84 Target outputs by project
87 <member name="M:Microsoft.Build.Framework.BuildEngineResult.#ctor(System.Boolean,System.Collections.Generic.List{System.Collections.Generic.IDictionary{System.String,Microsoft.Build.Framework.ITaskItem[]}})">
89 The constructor takes the result of the build and a list of the target outputs per project
92 <member name="P:Microsoft.Build.Framework.BuildEngineResult.Result">
94 Did the build pass or fail. True means the build succeeded, False means the build failed.
97 <member name="P:Microsoft.Build.Framework.BuildEngineResult.TargetOutputsPerProject">
99 Outputs of the targets per project.
102 <member name="T:Microsoft.Build.Framework.BuildErrorEventArgs">
104 Arguments for error events
107 WARNING: marking a type [Serializable] without implementing
108 ISerializable imposes a serialization contract -- it is a
109 promise to never change the type's fields i.e. the type is
110 immutable; adding new fields in the next version of the type
111 without following certain special FX guidelines, can break both
112 forward and backward compatibility
115 <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.subcategory">
117 Subcategory of the error
120 <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.code">
125 <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.file">
130 <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.projectFile">
132 The project which issued the event
135 <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.lineNumber">
140 <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.columnNumber">
145 <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.endLineNumber">
150 <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.endColumnNumber">
155 <member name="M:Microsoft.Build.Framework.BuildErrorEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String)">
157 This constructor allows all event data to be initialized
159 <param name="subcategory">event sub-category</param>
160 <param name="code">event code</param>
161 <param name="file">file associated with the event</param>
162 <param name="lineNumber">line number (0 if not applicable)</param>
163 <param name="columnNumber">column number (0 if not applicable)</param>
164 <param name="endLineNumber">end line number (0 if not applicable)</param>
165 <param name="endColumnNumber">end column number (0 if not applicable)</param>
166 <param name="message">text message</param>
167 <param name="helpKeyword">help keyword </param>
168 <param name="senderName">name of event sender</param>
170 <member name="M:Microsoft.Build.Framework.BuildErrorEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime)">
172 This constructor which allows a timestamp to be set
174 <param name="subcategory">event sub-category</param>
175 <param name="code">event code</param>
176 <param name="file">file associated with the event</param>
177 <param name="lineNumber">line number (0 if not applicable)</param>
178 <param name="columnNumber">column number (0 if not applicable)</param>
179 <param name="endLineNumber">end line number (0 if not applicable)</param>
180 <param name="endColumnNumber">end column number (0 if not applicable)</param>
181 <param name="message">text message</param>
182 <param name="helpKeyword">help keyword </param>
183 <param name="senderName">name of event sender</param>
184 <param name="eventTimestamp">Timestamp when event was created</param>
186 <member name="M:Microsoft.Build.Framework.BuildErrorEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime,System.Object[])">
188 This constructor which allows a timestamp to be set
190 <param name="subcategory">event sub-category</param>
191 <param name="code">event code</param>
192 <param name="file">file associated with the event</param>
193 <param name="lineNumber">line number (0 if not applicable)</param>
194 <param name="columnNumber">column number (0 if not applicable)</param>
195 <param name="endLineNumber">end line number (0 if not applicable)</param>
196 <param name="endColumnNumber">end column number (0 if not applicable)</param>
197 <param name="message">text message</param>
198 <param name="helpKeyword">help keyword </param>
199 <param name="senderName">name of event sender</param>
200 <param name="eventTimestamp">Timestamp when event was created</param>
201 <param name="messageArgs">message arguments</param>
203 <member name="M:Microsoft.Build.Framework.BuildErrorEventArgs.#ctor">
208 <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.Subcategory">
210 The custom sub-type of the event.
213 <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.Code">
215 Code associated with event.
218 <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.File">
220 File associated with event.
223 <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.ProjectFile">
225 The project file which issued this event.
228 <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.LineNumber">
230 Line number of interest in associated file.
233 <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.ColumnNumber">
235 Column number of interest in associated file.
238 <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.EndLineNumber">
240 Ending line number of interest in associated file.
243 <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.EndColumnNumber">
245 Ending column number of interest in associated file.
248 <member name="T:Microsoft.Build.Framework.BuildEventArgs">
250 This class encapsulates the default data associated with build events.
251 It is intended to be extended/sub-classed.
254 WARNING: marking a type [Serializable] without implementing
255 ISerializable imposes a serialization contract -- it is a
256 promise to never change the type's fields i.e. the type is
257 immutable; adding new fields in the next version of the type
258 without following certain special FX guidelines, can break both
259 forward and backward compatibility
262 <member name="F:Microsoft.Build.Framework.BuildEventArgs.message">
267 <member name="F:Microsoft.Build.Framework.BuildEventArgs.helpKeyword">
272 <member name="F:Microsoft.Build.Framework.BuildEventArgs.senderName">
277 <member name="F:Microsoft.Build.Framework.BuildEventArgs.timestamp">
282 <member name="F:Microsoft.Build.Framework.BuildEventArgs.threadId">
287 <member name="F:Microsoft.Build.Framework.BuildEventArgs.buildEventContext">
292 <member name="M:Microsoft.Build.Framework.BuildEventArgs.#ctor">
297 <member name="M:Microsoft.Build.Framework.BuildEventArgs.#ctor(System.String,System.String,System.String)">
299 This constructor allows all event data to be initialized
301 <param name="message">text message</param>
302 <param name="helpKeyword">help keyword </param>
303 <param name="senderName">name of event sender</param>
305 <member name="M:Microsoft.Build.Framework.BuildEventArgs.#ctor(System.String,System.String,System.String,System.DateTime)">
307 This constructor allows all event data to be initialized while providing a custom timestamp.
309 <param name="message">text message</param>
310 <param name="helpKeyword">help keyword </param>
311 <param name="senderName">name of event sender</param>
312 <param name="eventTimestamp">TimeStamp of when the event was created</param>
314 <member name="P:Microsoft.Build.Framework.BuildEventArgs.Timestamp">
316 The time when event was raised.
319 <member name="P:Microsoft.Build.Framework.BuildEventArgs.ThreadId">
321 The thread that raised event.
324 <member name="P:Microsoft.Build.Framework.BuildEventArgs.Message">
329 <member name="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword">
331 Custom help keyword associated with event.
334 <member name="P:Microsoft.Build.Framework.BuildEventArgs.SenderName">
336 Name of the object sending this event.
339 <member name="P:Microsoft.Build.Framework.BuildEventArgs.BuildEventContext">
341 Event contextual information for the build event argument
344 <member name="T:Microsoft.Build.Framework.BuildFinishedEventArgs">
346 This class represents the event arguments for build finished events.
349 WARNING: marking a type [Serializable] without implementing
350 ISerializable imposes a serialization contract -- it is a
351 promise to never change the type's fields i.e. the type is
352 immutable; adding new fields in the next version of the type
353 without following certain special FX guidelines, can break both
354 forward and backward compatibility
357 <member name="F:Microsoft.Build.Framework.BuildFinishedEventArgs.succeeded">
359 Whether the build succeeded
362 <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.#ctor">
367 <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.#ctor(System.String,System.String,System.Boolean)">
369 Constructor to initialize all parameters.
370 Sender field cannot be set here and is assumed to be "MSBuild"
372 <param name="message">text message</param>
373 <param name="helpKeyword">help keyword </param>
374 <param name="succeeded">True indicates a successful build</param>
376 <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.#ctor(System.String,System.String,System.Boolean,System.DateTime)">
378 Constructor which allows the timestamp to be set
380 <param name="message">text message</param>
381 <param name="helpKeyword">help keyword </param>
382 <param name="succeeded">True indicates a successful build</param>
383 <param name="eventTimestamp">Timestamp when the event was created</param>
385 <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.#ctor(System.String,System.String,System.Boolean,System.DateTime,System.Object[])">
387 Constructor which allows the timestamp to be set
389 <param name="message">text message</param>
390 <param name="helpKeyword">help keyword </param>
391 <param name="succeeded">True indicates a successful build</param>
392 <param name="eventTimestamp">Timestamp when the event was created</param>
393 <param name="messageArgs">message arguments</param>
395 <member name="P:Microsoft.Build.Framework.BuildFinishedEventArgs.Succeeded">
397 Succeeded is true if the build succeeded; false otherwise.
400 <member name="T:Microsoft.Build.Framework.MessageImportance">
402 This enumeration provides three levels of importance for messages.
405 <member name="F:Microsoft.Build.Framework.MessageImportance.High">
407 High importance, appears in less verbose logs
410 <member name="F:Microsoft.Build.Framework.MessageImportance.Normal">
415 <member name="F:Microsoft.Build.Framework.MessageImportance.Low">
417 Low importance, appears in more verbose logs
420 <member name="T:Microsoft.Build.Framework.BuildMessageEventArgs">
422 Arguments for message events
425 WARNING: marking a type [Serializable] without implementing
426 ISerializable imposes a serialization contract -- it is a
427 promise to never change the type's fields i.e. the type is
428 immutable; adding new fields in the next version of the type
429 without following certain special FX guidelines, can break both
430 forward and backward compatibility
433 <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor">
438 <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor(System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance)">
440 This constructor allows all event data to be initialized
442 <param name="message">text message</param>
443 <param name="helpKeyword">help keyword </param>
444 <param name="senderName">name of event sender</param>
445 <param name="importance">importance of the message</param>
447 <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor(System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime)">
449 This constructor allows a timestamp to be set
451 <param name="message">text message</param>
452 <param name="helpKeyword">help keyword </param>
453 <param name="senderName">name of event sender</param>
454 <param name="importance">importance of the message</param>
455 <param name="eventTimestamp">Timestamp when event was created</param>
457 <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor(System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime,System.Object[])">
459 This constructor allows a timestamp to be set
461 <param name="message">text message</param>
462 <param name="helpKeyword">help keyword </param>
463 <param name="senderName">name of event sender</param>
464 <param name="importance">importance of the message</param>
465 <param name="eventTimestamp">Timestamp when event was created</param>
466 <param name="messageArgs">message arguments</param>
468 <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance)">
470 This constructor allows all event data to be initialized
472 <param name="subcategory">event subcategory</param>
473 <param name="code">event code</param>
474 <param name="file">file associated with the event</param>
475 <param name="lineNumber">line number (0 if not applicable)</param>
476 <param name="columnNumber">column number (0 if not applicable)</param>
477 <param name="endLineNumber">end line number (0 if not applicable)</param>
478 <param name="endColumnNumber">end column number (0 if not applicable)</param>
479 <param name="message">text message</param>
480 <param name="helpKeyword">help keyword </param>
481 <param name="senderName">name of event sender</param>
482 <param name="importance">importance of the message</param>
484 <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime)">
486 This constructor allows timestamp to be set
488 <param name="subcategory">event subcategory</param>
489 <param name="code">event code</param>
490 <param name="file">file associated with the event</param>
491 <param name="lineNumber">line number (0 if not applicable)</param>
492 <param name="columnNumber">column number (0 if not applicable)</param>
493 <param name="endLineNumber">end line number (0 if not applicable)</param>
494 <param name="endColumnNumber">end column number (0 if not applicable)</param>
495 <param name="message">text message</param>
496 <param name="helpKeyword">help keyword </param>
497 <param name="senderName">name of event sender</param>
498 <param name="importance">importance of the message</param>
499 <param name="eventTimestamp">custom timestamp for the event</param>
501 <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime,System.Object[])">
503 This constructor allows timestamp to be set
505 <param name="subcategory">event subcategory</param>
506 <param name="code">event code</param>
507 <param name="file">file associated with the event</param>
508 <param name="lineNumber">line number (0 if not applicable)</param>
509 <param name="columnNumber">column number (0 if not applicable)</param>
510 <param name="endLineNumber">end line number (0 if not applicable)</param>
511 <param name="endColumnNumber">end column number (0 if not applicable)</param>
512 <param name="message">text message</param>
513 <param name="helpKeyword">help keyword </param>
514 <param name="senderName">name of event sender</param>
515 <param name="importance">importance of the message</param>
516 <param name="eventTimestamp">custom timestamp for the event</param>
517 <param name="messageArgs">message arguments</param>
519 <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.Importance">
521 Importance of the message
524 <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.Subcategory">
526 The custom sub-type of the event.
529 <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.Code">
531 Code associated with event.
534 <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.File">
536 File associated with event.
539 <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.LineNumber">
541 Line number of interest in associated file.
544 <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.ColumnNumber">
546 Column number of interest in associated file.
549 <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.EndLineNumber">
551 Ending line number of interest in associated file.
554 <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.EndColumnNumber">
556 Ending column number of interest in associated file.
559 <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.ProjectFile">
561 The project which was building when the message was issued.
564 <member name="T:Microsoft.Build.Framework.BuildStartedEventArgs">
566 Arguments for build started events.
569 WARNING: marking a type [Serializable] without implementing
570 ISerializable imposes a serialization contract -- it is a
571 promise to never change the type's fields i.e. the type is
572 immutable; adding new fields in the next version of the type
573 without following certain special FX guidelines, can break both
574 forward and backward compatibility
577 <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor">
582 <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor(System.String,System.String)">
584 Constructor to initialize all parameters.
585 Sender field cannot be set here and is assumed to be "MSBuild"
587 <param name="message">text message</param>
588 <param name="helpKeyword">help keyword </param>
590 <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
592 Constructor to initialize all parameters.
593 Sender field cannot be set here and is assumed to be "MSBuild"
595 <param name="message">text message</param>
596 <param name="helpKeyword">help keyword </param>
597 <param name="environmentOfBuild">A dictionary which lists the environment of the build when the build is started.</param>
599 <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor(System.String,System.String,System.DateTime)">
601 Constructor to allow timestamp to be set
603 <param name="message">text message</param>
604 <param name="helpKeyword">help keyword </param>
605 <param name="eventTimestamp">Timestamp when the event was created</param>
607 <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor(System.String,System.String,System.DateTime,System.Object[])">
609 Constructor to allow timestamp to be set
611 <param name="message">text message</param>
612 <param name="helpKeyword">help keyword </param>
613 <param name="eventTimestamp">Timestamp when the event was created</param>
614 <param name="messageArgs">message args</param>
616 <member name="P:Microsoft.Build.Framework.BuildStartedEventArgs.BuildEnvironment">
618 The environment which is used at the start of the build
621 <member name="T:Microsoft.Build.Framework.BuildStatusEventArgs">
623 Base class for build status events. This class is meant
627 WARNING: marking a type [Serializable] without implementing
628 ISerializable imposes a serialization contract -- it is a
629 promise to never change the type's fields i.e. the type is
630 immutable; adding new fields in the next version of the type
631 without following certain special FX guidelines, can break both
632 forward and backward compatibility
635 <member name="M:Microsoft.Build.Framework.BuildStatusEventArgs.#ctor">
640 <member name="M:Microsoft.Build.Framework.BuildStatusEventArgs.#ctor(System.String,System.String,System.String)">
642 This constructor allows event data to be initialized.
644 <param name="message">text message</param>
645 <param name="helpKeyword">help keyword </param>
646 <param name="senderName">name of event sender</param>
648 <member name="M:Microsoft.Build.Framework.BuildStatusEventArgs.#ctor(System.String,System.String,System.String,System.DateTime)">
650 This constructor allows timestamp to be set
652 <param name="message">text message</param>
653 <param name="helpKeyword">help keyword </param>
654 <param name="senderName">name of event sender</param>
655 <param name="eventTimestamp">Timestamp when event was created</param>
657 <member name="M:Microsoft.Build.Framework.BuildStatusEventArgs.#ctor(System.String,System.String,System.String,System.DateTime,System.Object[])">
659 This constructor allows timestamp to be set
661 <param name="message">text message</param>
662 <param name="helpKeyword">help keyword </param>
663 <param name="senderName">name of event sender</param>
664 <param name="eventTimestamp">Timestamp when event was created</param>
665 <param name="messageArgs">Optional arguments for formatting the message string.</param>
667 <member name="T:Microsoft.Build.Framework.BuildWarningEventArgs">
669 Arguments for warning events
672 WARNING: marking a type [Serializable] without implementing
673 ISerializable imposes a serialization contract -- it is a
674 promise to never change the type's fields i.e. the type is
675 immutable; adding new fields in the next version of the type
676 without following certain special FX guidelines, can break both
677 forward and backward compatibility
680 <member name="M:Microsoft.Build.Framework.BuildWarningEventArgs.#ctor">
685 <member name="M:Microsoft.Build.Framework.BuildWarningEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String)">
687 This constructor allows all event data to be initialized
689 <param name="subcategory">event subcategory</param>
690 <param name="code">event code</param>
691 <param name="file">file associated with the event</param>
692 <param name="lineNumber">line number (0 if not applicable)</param>
693 <param name="columnNumber">column number (0 if not applicable)</param>
694 <param name="endLineNumber">end line number (0 if not applicable)</param>
695 <param name="endColumnNumber">end column number (0 if not applicable)</param>
696 <param name="message">text message</param>
697 <param name="helpKeyword">help keyword </param>
698 <param name="senderName">name of event sender</param>
700 <member name="M:Microsoft.Build.Framework.BuildWarningEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime)">
702 This constructor allows timestamp to be set
704 <param name="subcategory">event subcategory</param>
705 <param name="code">event code</param>
706 <param name="file">file associated with the event</param>
707 <param name="lineNumber">line number (0 if not applicable)</param>
708 <param name="columnNumber">column number (0 if not applicable)</param>
709 <param name="endLineNumber">end line number (0 if not applicable)</param>
710 <param name="endColumnNumber">end column number (0 if not applicable)</param>
711 <param name="message">text message</param>
712 <param name="helpKeyword">help keyword </param>
713 <param name="senderName">name of event sender</param>
714 <param name="eventTimestamp">custom timestamp for the event</param>
716 <member name="M:Microsoft.Build.Framework.BuildWarningEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime,System.Object[])">
718 This constructor allows timestamp to be set
720 <param name="subcategory">event subcategory</param>
721 <param name="code">event code</param>
722 <param name="file">file associated with the event</param>
723 <param name="lineNumber">line number (0 if not applicable)</param>
724 <param name="columnNumber">column number (0 if not applicable)</param>
725 <param name="endLineNumber">end line number (0 if not applicable)</param>
726 <param name="endColumnNumber">end column number (0 if not applicable)</param>
727 <param name="message">text message</param>
728 <param name="helpKeyword">help keyword </param>
729 <param name="senderName">name of event sender</param>
730 <param name="eventTimestamp">custom timestamp for the event</param>
731 <param name="messageArgs">message arguments</param>
733 <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.Subcategory">
735 The custom sub-type of the event.
738 <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.Code">
740 Code associated with event.
743 <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.File">
745 File associated with event.
748 <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.LineNumber">
750 Line number of interest in associated file.
753 <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.ColumnNumber">
755 Column number of interest in associated file.
758 <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.EndLineNumber">
760 Ending line number of interest in associated file.
763 <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.EndColumnNumber">
765 Ending column number of interest in associated file.
768 <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.ProjectFile">
770 The project which was building when the message was issued.
773 <member name="T:Microsoft.Build.Framework.CriticalBuildMessageEventArgs">
775 Arguments for critical message events. These always have High importance.
778 WARNING: marking a type [Serializable] without implementing
779 ISerializable imposes a serialization contract -- it is a
780 promise to never change the type's fields i.e. the type is
781 immutable; adding new fields in the next version of the type
782 without following certain special FX guidelines, can break both
783 forward and backward compatibility
786 <member name="M:Microsoft.Build.Framework.CriticalBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String)">
788 This constructor allows all event data to be initialized
790 <param name="subcategory">event subcategory</param>
791 <param name="code">event code</param>
792 <param name="file">file associated with the event</param>
793 <param name="lineNumber">line number (0 if not applicable)</param>
794 <param name="columnNumber">column number (0 if not applicable)</param>
795 <param name="endLineNumber">end line number (0 if not applicable)</param>
796 <param name="endColumnNumber">end column number (0 if not applicable)</param>
797 <param name="message">text message</param>
798 <param name="helpKeyword">help keyword </param>
799 <param name="senderName">name of event sender</param>
801 <member name="M:Microsoft.Build.Framework.CriticalBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime)">
803 This constructor allows timestamp to be set
805 <param name="subcategory">event subcategory</param>
806 <param name="code">event code</param>
807 <param name="file">file associated with the event</param>
808 <param name="lineNumber">line number (0 if not applicable)</param>
809 <param name="columnNumber">column number (0 if not applicable)</param>
810 <param name="endLineNumber">end line number (0 if not applicable)</param>
811 <param name="endColumnNumber">end column number (0 if not applicable)</param>
812 <param name="message">text message</param>
813 <param name="helpKeyword">help keyword </param>
814 <param name="senderName">name of event sender</param>
815 <param name="eventTimestamp">custom timestamp for the event</param>
817 <member name="M:Microsoft.Build.Framework.CriticalBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime,System.Object[])">
819 This constructor allows timestamp to be set
821 <param name="subcategory">event subcategory</param>
822 <param name="code">event code</param>
823 <param name="file">file associated with the event</param>
824 <param name="lineNumber">line number (0 if not applicable)</param>
825 <param name="columnNumber">column number (0 if not applicable)</param>
826 <param name="endLineNumber">end line number (0 if not applicable)</param>
827 <param name="endColumnNumber">end column number (0 if not applicable)</param>
828 <param name="message">text message</param>
829 <param name="helpKeyword">help keyword </param>
830 <param name="senderName">name of event sender</param>
831 <param name="eventTimestamp">custom timestamp for the event</param>
832 <param name="messageArgs">message arguments</param>
834 <member name="M:Microsoft.Build.Framework.CriticalBuildMessageEventArgs.#ctor">
839 <member name="T:Microsoft.Build.Framework.CustomBuildEventArgs">
841 Arguments for custom build events.
844 WARNING: marking a type [Serializable] without implementing
845 ISerializable imposes a serialization contract -- it is a
846 promise to never change the type's fields i.e. the type is
847 immutable; adding new fields in the next version of the type
848 without following certain special FX guidelines, can break both
849 forward and backward compatibility
852 <member name="M:Microsoft.Build.Framework.CustomBuildEventArgs.#ctor">
857 <member name="M:Microsoft.Build.Framework.CustomBuildEventArgs.#ctor(System.String,System.String,System.String)">
859 This constructor allows event data to be initialized.
861 <param name="message">text message</param>
862 <param name="helpKeyword">help keyword </param>
863 <param name="senderName">name of sender</param>
865 <member name="M:Microsoft.Build.Framework.CustomBuildEventArgs.#ctor(System.String,System.String,System.String,System.DateTime)">
867 This constructor allows event data to be initialized including timestamp.
869 <param name="message">text message</param>
870 <param name="helpKeyword">help keyword </param>
871 <param name="senderName">name of sender</param>
872 <param name="eventTimestamp">Timestamp when event was created</param>
874 <member name="M:Microsoft.Build.Framework.CustomBuildEventArgs.#ctor(System.String,System.String,System.String,System.DateTime,System.Object[])">
876 This constructor allows event data to be initialized including timestamp.
878 <param name="message">text message</param>
879 <param name="helpKeyword">help keyword </param>
880 <param name="senderName">name of sender</param>
881 <param name="eventTimestamp">Timestamp when event was created</param>
882 <param name="messageArgs">Message arguments</param>
884 <member name="T:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs">
886 Arguments for external project finished events
889 WARNING: marking a type [Serializable] without implementing
890 ISerializable imposes a serialization contract -- it is a
891 promise to never change the type's fields i.e. the type is
892 immutable; adding new fields in the next version of the type
893 without following certain special FX guidelines, can break both
894 forward and backward compatibility
897 <member name="M:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.#ctor">
902 <member name="M:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Boolean)">
906 <param name="message">text message</param>
907 <param name="helpKeyword">help keyword</param>
908 <param name="senderName">name of the object sending this event</param>
909 <param name="projectFile">project name</param>
910 <param name="succeeded">true indicates project built successfully</param>
912 <member name="M:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Boolean,System.DateTime)">
914 Useful constructor including the ability to set the timestamp
916 <param name="message">text message</param>
917 <param name="helpKeyword">help keyword</param>
918 <param name="senderName">name of the object sending this event</param>
919 <param name="projectFile">project name</param>
920 <param name="succeeded">true indicates project built successfully</param>
921 <param name="eventTimestamp">Timestamp when event was created</param>
923 <member name="P:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.ProjectFile">
928 <member name="P:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.Succeeded">
930 True if project built successfully, false otherwise
933 <member name="T:Microsoft.Build.Framework.ExternalProjectStartedEventArgs">
935 Arguments for external project started events
938 WARNING: marking a type [Serializable] without implementing
939 ISerializable imposes a serialization contract -- it is a
940 promise to never change the type's fields i.e. the type is
941 immutable; adding new fields in the next version of the type
942 without following certain special FX guidelines, can break both
943 forward and backward compatibility
946 <member name="M:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.#ctor">
951 <member name="M:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String)">
955 <param name="message">text message</param>
956 <param name="helpKeyword">help keyword</param>
957 <param name="senderName">name of the object sending this event</param>
958 <param name="projectFile">project name</param>
959 <param name="targetNames">targets we are going to build (empty indicates default targets)</param>
961 <member name="M:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.DateTime)">
963 Useful constructor, including the ability to set the timestamp of the event
965 <param name="message">text message</param>
966 <param name="helpKeyword">help keyword</param>
967 <param name="senderName">name of the object sending this event</param>
968 <param name="projectFile">project name</param>
969 <param name="targetNames">targets we are going to build (empty indicates default targets)</param>
970 <param name="eventTimestamp">Timestamp when the event was created</param>
972 <member name="P:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.ProjectFile">
977 <member name="P:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.TargetNames">
979 Targets that we will build in the project. This may mean different things for different project types,
980 our tasks will put something like Rebuild, Clean, etc. here. This may be null if the project is being
981 built with the default target.
984 <member name="T:Microsoft.Build.Framework.IBuildEngine3">
986 This interface extends IBuildEngine to provide a method allowing building
987 project files in parallel.
990 <member name="M:Microsoft.Build.Framework.IBuildEngine3.BuildProjectFilesInParallel(System.String[],System.String[],System.Collections.IDictionary[],System.Collections.Generic.IList{System.String}[],System.String[],System.Boolean)">
992 This method allows tasks to initiate a build on a
993 particular project file. If the build is successful, the outputs
994 (if any) of the specified targets are returned.
997 1) it is acceptable to pass null for both <c>targetNames</c> and <c>targetOutputs</c>
998 2) if no targets are specified, the default targets are built
1001 <param name="projectFileNames">The project to build.</param>
1002 <param name="targetNames">The targets in the project to build (can be null).</param>
1003 <param name="globalProperties">An array of hashtables of additional global properties to apply
1004 to the child project (array entries can be null).
1005 The key and value in the hashtable should both be strings.</param>
1006 <param name="removeGlobalProperties">A list of global properties which should be removed.</param>
1007 <param name="toolsVersion">A tools version recognized by the Engine that will be used during this build (can be null).</param>
1008 <param name="returnTargetOutputs">Should the target outputs be returned in the BuildEngineResult</param>
1009 <returns>Returns a structure containing the success or failure of the build and the target outputs by project.</returns>
1011 <member name="M:Microsoft.Build.Framework.IBuildEngine3.Yield">
1013 Informs the system that this task has a long-running out-of-process component and other work can be done in the
1014 build while that work completes.
1017 <member name="M:Microsoft.Build.Framework.IBuildEngine3.Reacquire">
1019 Waits to reacquire control after yielding.
1022 <member name="T:Microsoft.Build.Framework.RegisteredTaskObjectLifetime">
1024 Defines the lifetime of a registered task object.
1027 <member name="F:Microsoft.Build.Framework.RegisteredTaskObjectLifetime.Build">
1029 The registered object will be disposed when the build ends.
1032 <member name="F:Microsoft.Build.Framework.RegisteredTaskObjectLifetime.AppDomain">
1034 The registered object will be disposed when the AppDomain is unloaded.
1037 The AppDomain to which this refers is the one in which MSBuild was launched,
1038 not the one in which the Task was launched.
1041 <member name="T:Microsoft.Build.Framework.IBuildEngine4">
1043 This interface extends IBuildEngine to provide a mechanism allowing tasks to
1044 share data between task invocations.
1047 <member name="M:Microsoft.Build.Framework.IBuildEngine4.RegisterTaskObject(System.Object,System.Object,Microsoft.Build.Framework.RegisteredTaskObjectLifetime,System.Boolean)">
1049 Registers an object with the system that will be disposed of at some specified time
1052 <param name="key">The key used to retrieve the object.</param>
1053 <param name="obj">The object to be held for later disposal.</param>
1054 <param name="lifetime">The lifetime of the object.</param>
1055 <param name="allowEarlyCollection">The object may be disposed earlier that the requested time if
1056 MSBuild needs to reclaim memory.</param>
1059 This method may be called by tasks which need to maintain state across task invocations,
1060 such as to cache data which may be expensive to generate but which is known not to change during the
1061 build. It is strongly recommended that <paramref name="allowEarlyCollection"/> be set to true if the
1062 object will retain any significant amount of data, as this gives MSBuild the most flexibility to
1063 manage limited process memory resources.
1066 The thread on which the object is disposed may be arbitrary - however it is guaranteed not to
1067 be disposed while the task is executing, even if <paramref name="allowEarlyCollection"/> is set
1071 If the object implements IDisposable, IDisposable.Dispose will be invoked on the object before
1076 <member name="M:Microsoft.Build.Framework.IBuildEngine4.GetRegisteredTaskObject(System.Object,Microsoft.Build.Framework.RegisteredTaskObjectLifetime)">
1078 Retrieves a previously registered task object stored with the specified key.
1080 <param name="key">The key used to retrieve the object.</param>
1081 <param name="lifetime">The lifetime of the object.</param>
1083 The registered object, or null is there is no object registered under that key or the object
1084 has been discarded through early collection.
1087 <member name="M:Microsoft.Build.Framework.IBuildEngine4.UnregisterTaskObject(System.Object,Microsoft.Build.Framework.RegisteredTaskObjectLifetime)">
1089 Unregisters a previously-registered task object.
1091 <param name="key">The key used to retrieve the object.</param>
1092 <param name="lifetime">The lifetime of the object.</param>
1094 The registered object, or null is there is no object registered under that key or the object
1095 has been discarded through early collection.
1098 <member name="T:Microsoft.Build.Framework.IBuildEngine5">
1100 This interface extends IBuildEngine to log telemetry.
1103 <member name="M:Microsoft.Build.Framework.IBuildEngine5.LogTelemetry(System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
1107 <param name="eventName">The event name.</param>
1108 <param name="properties">The event properties.</param>
1110 <member name="T:Microsoft.Build.Framework.TelemetryEventHandler">
1112 Type of handler for TelemetryLogged events
1115 <member name="T:Microsoft.Build.Framework.IEventSource2">
1117 This interface defines the events raised by the build engine.
1118 Loggers use this interface to subscribe to the events they
1119 are interested in receiving.
1122 <member name="E:Microsoft.Build.Framework.IEventSource2.TelemetryLogged">
1124 this event is raised to when telemetry is logged.
1127 <member name="T:Microsoft.Build.Framework.IGeneratedTask">
1129 An interface implemented by tasks that are generated by ITaskFactory instances.
1132 <member name="M:Microsoft.Build.Framework.IGeneratedTask.SetPropertyValue(Microsoft.Build.Framework.TaskPropertyInfo,System.Object)">
1134 Sets a value on a property of this task instance.
1136 <param name="property">The property to set.</param>
1137 <param name="value">The value to set. The caller is responsible to type-coerce this value to match the property's <see cref="P:Microsoft.Build.Framework.TaskPropertyInfo.PropertyType"/>.</param>
1139 All exceptions from this method will be caught in the taskExecution host and logged as a fatal task error
1142 <member name="M:Microsoft.Build.Framework.IGeneratedTask.GetPropertyValue(Microsoft.Build.Framework.TaskPropertyInfo)">
1144 Gets the property value.
1146 <param name="property">The property to get.</param>
1148 The value of the property, the value's type will match the type given by <see cref="P:Microsoft.Build.Framework.TaskPropertyInfo.PropertyType"/>.
1151 MSBuild calls this method after executing the task to get output parameters.
1152 All exceptions from this method will be caught in the taskExecution host and logged as a fatal task error
1155 <member name="T:Microsoft.Build.Framework.LazyFormattedBuildEventArgs">
1157 Stores strings for parts of a message delaying the formatting until it needs to be shown
1160 <member name="F:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.arguments">
1162 Stores the message arguments.
1165 <member name="F:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.originalCulture">
1167 Stores the original culture for String.Format.
1170 <member name="F:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.locker">
1175 <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.#ctor(System.String,System.String,System.String)">
1177 This constructor allows all event data to be initialized.
1179 <param name="message">text message.</param>
1180 <param name="helpKeyword">help keyword.</param>
1181 <param name="senderName">name of event sender.</param>
1183 <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.#ctor(System.String,System.String,System.String,System.DateTime,System.Object[])">
1185 This constructor that allows message arguments that are lazily formatted.
1187 <param name="message">text message.</param>
1188 <param name="helpKeyword">help keyword.</param>
1189 <param name="senderName">name of event sender.</param>
1190 <param name="eventTimestamp">Timestamp when event was created.</param>
1191 <param name="messageArgs">Message arguments.</param>
1193 <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.#ctor">
1195 Default constructor.
1198 <member name="P:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.Message">
1200 Gets the formatted message.
1203 <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.FormatString(System.Globalization.CultureInfo,System.String,System.Object[])">
1205 Formats the given string using the variable arguments passed in.
1207 PERF WARNING: calling a method that takes a variable number of arguments is expensive, because memory is allocated for
1208 the array of arguments -- do not call this method repeatedly in performance-critical scenarios
1210 <remarks>This method is thread-safe.</remarks>
1211 <param name="culture">The culture info for formatting the message.</param>
1212 <param name="unformatted">The string to format.</param>
1213 <param name="args">Optional arguments for formatting the given string.</param>
1214 <returns>The formatted string.</returns>
1216 <member name="T:Microsoft.Build.Framework.IBuildEngine">
1218 This interface exposes functionality on the build engine
1219 that is required for task authoring.
1222 <member name="M:Microsoft.Build.Framework.IBuildEngine.LogErrorEvent(Microsoft.Build.Framework.BuildErrorEventArgs)">
1224 Allows tasks to raise error events to all registered loggers.
1225 The build engine may perform some filtering or
1226 pre-processing on the events, before dispatching them.
1228 <param name="e">Details of event to raise.</param>
1230 <member name="M:Microsoft.Build.Framework.IBuildEngine.LogWarningEvent(Microsoft.Build.Framework.BuildWarningEventArgs)">
1232 Allows tasks to raise warning events to all registered loggers.
1233 The build engine may perform some filtering or
1234 pre-processing on the events, before dispatching them.
1236 <param name="e">Details of event to raise.</param>
1238 <member name="M:Microsoft.Build.Framework.IBuildEngine.LogMessageEvent(Microsoft.Build.Framework.BuildMessageEventArgs)">
1240 Allows tasks to raise message events to all registered loggers.
1241 The build engine may perform some filtering or
1242 pre-processing on the events, before dispatching them.
1244 <param name="e">Details of event to raise.</param>
1246 <member name="M:Microsoft.Build.Framework.IBuildEngine.LogCustomEvent(Microsoft.Build.Framework.CustomBuildEventArgs)">
1248 Allows tasks to raise custom events to all registered loggers.
1249 The build engine may perform some filtering or
1250 pre-processing on the events, before dispatching them.
1252 <param name="e">Details of event to raise.</param>
1254 <member name="P:Microsoft.Build.Framework.IBuildEngine.ContinueOnError">
1256 Returns true if the ContinueOnError flag was set to true for this particular task
1257 in the project file.
1260 <member name="P:Microsoft.Build.Framework.IBuildEngine.LineNumberOfTaskNode">
1262 Retrieves the line number of the task node within the project file that called it.
1265 <member name="P:Microsoft.Build.Framework.IBuildEngine.ColumnNumberOfTaskNode">
1267 Retrieves the line number of the task node within the project file that called it.
1270 <member name="P:Microsoft.Build.Framework.IBuildEngine.ProjectFileOfTaskNode">
1272 Returns the full path to the project file that contained the call to this task.
1275 <member name="M:Microsoft.Build.Framework.IBuildEngine.BuildProjectFile(System.String,System.String[],System.Collections.IDictionary,System.Collections.IDictionary)">
1277 This method allows tasks to initiate a build on a
1278 particular project file. If the build is successful, the outputs
1279 (if any) of the specified targets are returned.
1282 1) it is acceptable to pass null for both <c>targetNames</c> and <c>targetOutputs</c>
1283 2) if no targets are specified, the default targets are built
1284 3) target outputs are returned as <c>ITaskItem</c> arrays indexed by target name
1286 <param name="projectFileName">The project to build.</param>
1287 <param name="targetNames">The targets in the project to build (can be null).</param>
1288 <param name="globalProperties">A hash table of additional global properties to apply
1289 to the child project (can be null). The key and value should both be strings.</param>
1290 <param name="targetOutputs">The outputs of each specified target (can be null).</param>
1291 <returns>true, if build was successful</returns>
1293 <member name="T:Microsoft.Build.Framework.IBuildEngine2">
1295 This interface extends IBuildEngine to provide a method allowing building
1296 project files in parallel.
1299 <member name="P:Microsoft.Build.Framework.IBuildEngine2.IsRunningMultipleNodes">
1301 This property allows a task to query whether or not the system is running in single process mode or multi process mode.
1302 Single process mode (IsRunningMultipleNodes = false) is where the engine is initialized with the number of cpus = 1 and the engine is not a child engine.
1303 The engine is in multi process mode (IsRunningMultipleNodes = true) when the engine is initialized with a number of cpus > 1 or the engine is a child engine.
1306 <member name="M:Microsoft.Build.Framework.IBuildEngine2.BuildProjectFile(System.String,System.String[],System.Collections.IDictionary,System.Collections.IDictionary,System.String)">
1308 This method allows tasks to initiate a build on a
1309 particular project file. If the build is successful, the outputs
1310 (if any) of the specified targets are returned.
1313 1) it is acceptable to pass null for both <c>targetNames</c> and <c>targetOutputs</c>
1314 2) if no targets are specified, the default targets are built
1315 3) target outputs are returned as <c>ITaskItem</c> arrays indexed by target name
1317 <param name="projectFileName">The project to build.</param>
1318 <param name="targetNames">The targets in the project to build (can be null).</param>
1319 <param name="globalProperties">A hash table of additional global properties to apply
1320 to the child project (can be null). The key and value should both be strings.</param>
1321 <param name="targetOutputs">The outputs of each specified target (can be null).</param>
1322 <param name="toolsVersion">A tools version recognized by the Engine that will be used during this build (can be null).</param>
1323 <returns>true, if build was successful</returns>
1325 <member name="M:Microsoft.Build.Framework.IBuildEngine2.BuildProjectFilesInParallel(System.String[],System.String[],System.Collections.IDictionary[],System.Collections.IDictionary[],System.String[],System.Boolean,System.Boolean)">
1327 This method allows tasks to initiate a build on a
1328 particular project file. If the build is successful, the outputs
1329 (if any) of the specified targets are returned.
1332 1) it is acceptable to pass null for both <c>targetNames</c> and <c>targetOutputs</c>
1333 2) if no targets are specified, the default targets are built
1334 3) target outputs are returned as <c>ITaskItem</c> arrays indexed by target name
1336 <param name="projectFileNames">The project to build.</param>
1337 <param name="targetNames">The targets in the project to build (can be null).</param>
1338 <param name="globalProperties">An array of hashtables of additional global properties to apply
1339 to the child project (array entries can be null).
1340 The key and value in the hashtable should both be strings.</param>
1341 <param name="targetOutputsPerProject">The outputs of each specified target (can be null).</param>
1342 <param name="toolsVersion">A tools version recognized by the Engine that will be used during this build (can be null).</param>
1343 <param name="useResultsCache">If true the operation will only be run if the cache doesn't
1344 already contain the result. After the operation the result is
1345 stored in the cache </param>
1346 <param name="unloadProjectsOnCompletion">If true the project will be unloaded once the
1347 operation is completed </param>
1348 <returns>true, if build was successful</returns>
1350 <member name="T:Microsoft.Build.Framework.IEventRedirector">
1352 This interface is used to forward events to another loggers
1355 <member name="M:Microsoft.Build.Framework.IEventRedirector.ForwardEvent(Microsoft.Build.Framework.BuildEventArgs)">
1357 This method is called by the node loggers to forward the events to central logger
1360 <member name="T:Microsoft.Build.Framework.BuildMessageEventHandler">
1362 Type of handler for MessageRaised events
1365 <member name="T:Microsoft.Build.Framework.BuildErrorEventHandler">
1367 Type of handler for ErrorRaised events
1370 <member name="T:Microsoft.Build.Framework.BuildWarningEventHandler">
1372 Type of handler for WarningRaised events
1375 <member name="T:Microsoft.Build.Framework.CustomBuildEventHandler">
1377 Type of handler for CustomEventRaised events
1380 <member name="T:Microsoft.Build.Framework.BuildStartedEventHandler">
1382 Type of handler for BuildStartedEvent events
1385 <member name="T:Microsoft.Build.Framework.BuildFinishedEventHandler">
1387 Type of handler for BuildFinishedEvent events
1390 <member name="T:Microsoft.Build.Framework.ProjectStartedEventHandler">
1392 Type of handler for ProjectStarted events
1395 <member name="T:Microsoft.Build.Framework.ProjectFinishedEventHandler">
1397 Type of handler for ProjectFinished events
1400 <member name="T:Microsoft.Build.Framework.TargetStartedEventHandler">
1402 Type of handler for TargetStarted events
1405 <member name="T:Microsoft.Build.Framework.TargetFinishedEventHandler">
1407 Type of handler for TargetFinished events
1410 <member name="T:Microsoft.Build.Framework.TaskStartedEventHandler">
1412 Type of handler for TaskStarted events
1415 <member name="T:Microsoft.Build.Framework.TaskFinishedEventHandler">
1417 Type of handler for TaskFinished events
1420 <member name="T:Microsoft.Build.Framework.BuildStatusEventHandler">
1422 Type of handler for BuildStatus events
1425 <member name="T:Microsoft.Build.Framework.AnyEventHandler">
1427 Type of handler for AnyEventRaised events
1430 <member name="T:Microsoft.Build.Framework.IEventSource">
1432 This interface defines the events raised by the build engine.
1433 Loggers use this interface to subscribe to the events they
1434 are interested in receiving.
1437 <member name="E:Microsoft.Build.Framework.IEventSource.MessageRaised">
1439 this event is raised to log a message
1442 <member name="E:Microsoft.Build.Framework.IEventSource.ErrorRaised">
1444 this event is raised to log an error
1447 <member name="E:Microsoft.Build.Framework.IEventSource.WarningRaised">
1449 this event is raised to log a warning
1452 <member name="E:Microsoft.Build.Framework.IEventSource.BuildStarted">
1454 this event is raised to log the start of a build
1457 <member name="E:Microsoft.Build.Framework.IEventSource.BuildFinished">
1459 this event is raised to log the end of a build
1462 <member name="E:Microsoft.Build.Framework.IEventSource.ProjectStarted">
1464 this event is raised to log the start of a project build
1467 <member name="E:Microsoft.Build.Framework.IEventSource.ProjectFinished">
1469 this event is raised to log the end of a project build
1472 <member name="E:Microsoft.Build.Framework.IEventSource.TargetStarted">
1474 this event is raised to log the start of a target build
1477 <member name="E:Microsoft.Build.Framework.IEventSource.TargetFinished">
1479 this event is raised to log the end of a target build
1482 <member name="E:Microsoft.Build.Framework.IEventSource.TaskStarted">
1484 this event is raised to log the start of task execution
1487 <member name="E:Microsoft.Build.Framework.IEventSource.TaskFinished">
1489 this event is raised to log the end of task execution
1492 <member name="E:Microsoft.Build.Framework.IEventSource.CustomEventRaised">
1494 this event is raised to log custom events
1497 <member name="E:Microsoft.Build.Framework.IEventSource.StatusEventRaised">
1499 this event is raised to log any build status event
1502 <member name="E:Microsoft.Build.Framework.IEventSource.AnyEventRaised">
1504 this event is raised to log any build event. These events do not include telemetry. To receive telemetry, you must attach to the <see cref="E:Microsoft.Build.Framework.IEventSource2.TelemetryLogged"/> event.
1507 <member name="T:Microsoft.Build.Framework.IForwardingLogger">
1509 This interface extends the ILogger interface to provide a property which can be used to forward events
1510 to a logger running in a different process. It can also be used create filtering loggers.
1513 <member name="P:Microsoft.Build.Framework.IForwardingLogger.BuildEventRedirector">
1515 This property is set by the build engine to allow a node loggers to forward messages to the
1519 <member name="P:Microsoft.Build.Framework.IForwardingLogger.NodeId">
1521 This property is set by the build engine or node to inform the forwarding logger which node it is running on
1524 <member name="T:Microsoft.Build.Framework.LoggerVerbosity">
1526 Enumeration of the levels of detail of an event log.
1529 The level of detail (i.e. verbosity) of an event log is entirely controlled by the logger generating the log -- a logger
1530 will be directed to keep its verbosity at a certain level, based on user preferences, but a logger is free to choose the
1531 events it logs for each verbosity level.
1533 LOGGING GUIDELINES FOR EACH VERBOSITY LEVEL:
1534 1) Quiet -- only display a summary at the end of build
1535 2) Minimal -- only display errors, warnings, high importance events and a build summary
1536 3) Normal -- display all errors, warnings, high importance events, some status events, and a build summary
1537 4) Detailed -- display all errors, warnings, high and normal importance events, all status events, and a build summary
1538 5) Diagnostic -- display all events, and a build summary
1540 WARNING: VS Automation code for the Tools/Options MSBuild build verbosity setting will be broken
1541 by changes to this enum (not to mention existing MSBuild clients and vsproject code).
1542 Please make sure to talk to automation devs before changing it.
1545 <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Quiet">
1547 The most minimal output
1550 <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Minimal">
1552 Relatively little output
1555 <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Normal">
1557 Standard output. This should be the default if verbosity level is not set
1560 <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Detailed">
1562 Relatively verbose, but not exhaustive
1565 <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Diagnostic">
1567 The most verbose and informative verbosity
1570 <member name="T:Microsoft.Build.Framework.ILogger">
1572 This interface defines a "logger" in the build system. A logger subscribes to build system events. All logger classes must
1573 implement this interface to be recognized by the build engine.
1576 <member name="P:Microsoft.Build.Framework.ILogger.Verbosity">
1578 The verbosity level directs the amount of detail that appears in a logger's event log. Though this is only a
1579 recommendation based on user preferences, and a logger is free to choose the exact events it logs, it is still
1580 important that the guidelines for each level be followed, for a good user experience.
1582 <value>The verbosity level.</value>
1584 <member name="P:Microsoft.Build.Framework.ILogger.Parameters">
1586 This property holds the user-specified parameters to the logger. If parameters are not provided, a logger should revert
1587 to defaults. If a logger does not take parameters, it can ignore this property.
1589 <value>The parameter string (can be null).</value>
1591 <member name="M:Microsoft.Build.Framework.ILogger.Initialize(Microsoft.Build.Framework.IEventSource)">
1593 Called by the build engine to allow loggers to subscribe to the events they desire.
1595 <param name="eventSource">The events available to loggers.</param>
1597 <member name="M:Microsoft.Build.Framework.ILogger.Shutdown">
1599 Called by the build engine to allow loggers to release any resources they may have allocated at initialization time,
1600 or during the build.
1603 <member name="T:Microsoft.Build.Framework.INodeLogger">
1605 This interface defines a "parallel aware logger" in the build system. A parallel aware logger
1606 will accept a cpu count and be aware that any cpu count greater than 1 means the events will
1607 be received from the logger from each cpu as the events are logged.
1610 <member name="M:Microsoft.Build.Framework.INodeLogger.Initialize(Microsoft.Build.Framework.IEventSource,System.Int32)">
1612 Initializes the current <see cref="T:Microsoft.Build.Framework.INodeLogger"/> instance.
1614 <param name="eventSource"></param>
1615 <param name="nodeCount"></param>
1617 <member name="T:Microsoft.Build.Framework.ITask">
1619 This interface defines a "task" in the build system. A task is an atomic unit of build operation. All task classes must
1620 implement this interface to be recognized by the build engine.
1623 <member name="P:Microsoft.Build.Framework.ITask.BuildEngine">
1625 This property is set by the build engine to allow a task to call back into it.
1627 <value>The interface on the build engine available to tasks.</value>
1629 <member name="P:Microsoft.Build.Framework.ITask.HostObject">
1631 The build engine sets this property if the host IDE has associated a host object with this particular task.
1633 <value>The host object instance (can be null).</value>
1635 <member name="M:Microsoft.Build.Framework.ITask.Execute">
1637 This method is called by the build engine to begin task execution. A task uses the return value to indicate
1638 whether it was successful. If a task throws an exception out of this method, the engine will automatically
1639 assume that the task has failed.
1641 <returns>true, if successful</returns>
1643 <member name="T:Microsoft.Build.Framework.ICancelableTask">
1645 Interface for tasks which can be cancelled.
1648 <member name="M:Microsoft.Build.Framework.ICancelableTask.Cancel">
1650 Instructs the task to exit as soon as possible, or to immediately exit if Execute is invoked after this method.
1653 Cancel() may be called at any time after the task has been instantiated, even before <see cref="M:Microsoft.Build.Framework.ITask.Execute"/> is called.
1654 Cancel calls may come in from any thread. The implementation of this method should not block indefinitely.
1657 <member name="T:Microsoft.Build.Framework.ITaskFactory">
1659 Interface that a task factory Instance should implement
1662 <member name="P:Microsoft.Build.Framework.ITaskFactory.FactoryName">
1664 Gets the name of the factory.
1666 <value>The name of the factory.</value>
1668 <member name="P:Microsoft.Build.Framework.ITaskFactory.TaskType">
1670 Gets the type of the task this factory will instantiate.
1673 <member name="M:Microsoft.Build.Framework.ITaskFactory.Initialize(System.String,System.Collections.Generic.IDictionary{System.String,Microsoft.Build.Framework.TaskPropertyInfo},System.String,Microsoft.Build.Framework.IBuildEngine)">
1675 Initializes this factory for instantiating tasks with a particular inline task block.
1677 <param name="taskName">Name of the task.</param>
1678 <param name="parameterGroup">The parameter group.</param>
1679 <param name="taskBody">The task body.</param>
1680 <param name="taskFactoryLoggingHost">The task factory logging host.</param>
1681 <returns>A value indicating whether initialization was successful.</returns>
1683 <para>MSBuild engine will call this to initialize the factory. This should initialize the factory enough so that the factory can be asked
1684 whether or not task names can be created by the factory.</para>
1686 The taskFactoryLoggingHost will log messages in the context of the target where the task is first used.
1690 <member name="M:Microsoft.Build.Framework.ITaskFactory.GetTaskParameters">
1692 Get the descriptions for all the task's parameters.
1694 <returns>A non-null array of property descriptions.</returns>
1696 <member name="M:Microsoft.Build.Framework.ITaskFactory.CreateTask(Microsoft.Build.Framework.IBuildEngine)">
1698 Create an instance of the task to be used.
1700 <param name="taskFactoryLoggingHost">
1701 The task factory logging host will log messages in the context of the task.
1704 The generated task, or <c>null</c> if the task failed to be created.
1707 <member name="M:Microsoft.Build.Framework.ITaskFactory.CleanupTask(Microsoft.Build.Framework.ITask)">
1709 Cleans up any context or state that may have been built up for a given task.
1711 <param name="task">The task to clean up.</param>
1713 For many factories, this method is a no-op. But some factories may have built up
1714 an AppDomain as part of an individual task instance, and this is their opportunity
1715 to shutdown the AppDomain.
1718 <member name="T:Microsoft.Build.Framework.ITaskFactory2">
1720 Interface that a task factory Instance should implement if it wants to be able to
1721 use new UsingTask parameters such as Runtime and Architecture.
1724 <member name="M:Microsoft.Build.Framework.ITaskFactory2.Initialize(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,Microsoft.Build.Framework.TaskPropertyInfo},System.String,Microsoft.Build.Framework.IBuildEngine)">
1726 Initializes this factory for instantiating tasks with a particular inline task block and a set of UsingTask parameters. MSBuild
1727 provides an implementation of this interface, TaskHostFactory, that uses "Runtime", with values "CLR2", "CLR4", "CurrentRuntime",
1728 and "*" (Any); and "Architecture", with values "x86", "x64", "CurrentArchitecture", and "*" (Any). An implementer of ITaskFactory2
1729 can choose to use these pre-defined Runtime and Architecture values, or can specify new values for these parameters.
1731 <param name="taskName">Name of the task.</param>
1732 <param name="factoryIdentityParameters">Special parameters that the task factory can use to modify how it executes tasks,
1733 such as Runtime and Architecture. The key is the name of the parameter and the value is the parameter's value. This
1734 is the set of parameters that was set on the UsingTask using e.g. the UsingTask Runtime and Architecture parameters.</param>
1735 <param name="parameterGroup">The parameter group.</param>
1736 <param name="taskBody">The task body.</param>
1737 <param name="taskFactoryLoggingHost">The task factory logging host.</param>
1738 <returns>A value indicating whether initialization was successful.</returns>
1740 <para>MSBuild engine will call this to initialize the factory. This should initialize the factory enough so that the
1741 factory can be asked whether or not task names can be created by the factory. If a task factory implements ITaskFactory2,
1742 this Initialize method will be called in place of ITaskFactory.Initialize.</para>
1744 The taskFactoryLoggingHost will log messages in the context of the target where the task is first used.
1748 <member name="M:Microsoft.Build.Framework.ITaskFactory2.CreateTask(Microsoft.Build.Framework.IBuildEngine,System.Collections.Generic.IDictionary{System.String,System.String})">
1750 Create an instance of the task to be used, with an optional set of "special" parameters set on the individual task invocation using
1751 the MSBuildRuntime and MSBuildArchitecture default task parameters. MSBuild provides an implementation of this interface,
1752 TaskHostFactory, that uses "MSBuildRuntime", with values "CLR2", "CLR4", "CurrentRuntime", and "*" (Any); and "MSBuildArchitecture",
1753 with values "x86", "x64", "CurrentArchitecture", and "*" (Any). An implementer of ITaskFactory2 can choose to use these pre-defined
1754 MSBuildRuntime and MSBuildArchitecture values, or can specify new values for these parameters.
1756 <param name="taskFactoryLoggingHost">
1757 The task factory logging host will log messages in the context of the task.
1759 <param name="taskIdentityParameters">
1760 Special parameters that the task factory can use to modify how it executes tasks, such as Runtime and Architecture.
1761 The key is the name of the parameter and the value is the parameter's value. This is the set of parameters that was
1762 set to the task invocation itself, via e.g. the special MSBuildRuntime and MSBuildArchitecture parameters.
1765 If a task factory implements ITaskFactory2, MSBuild will call this method instead of ITaskFactory.CreateTask.
1768 The generated task, or <c>null</c> if the task failed to be created.
1771 <member name="T:Microsoft.Build.Framework.ITaskHost">
1773 This empty interface is used to pass host objects from an IDE to individual
1774 tasks. Depending on the task itself and what kinds parameters and functionality
1775 it exposes, the task should define its own interface that inherits from this one,
1776 and then use that interface to communicate with the host.
1779 <member name="T:Microsoft.Build.Framework.ITaskItem">
1781 This interface defines a project item that can be consumed and emitted by tasks.
1784 <member name="P:Microsoft.Build.Framework.ITaskItem.ItemSpec">
1786 Gets or sets the item "specification" e.g. for disk-based items this would be the file path.
1789 This should be named "EvaluatedInclude" but that would be a breaking change to this interface.
1791 <value>The item-spec string.</value>
1793 <member name="P:Microsoft.Build.Framework.ITaskItem.MetadataNames">
1795 Gets the names of all the metadata on the item.
1796 Includes the built-in metadata like "FullPath".
1798 <value>The list of metadata names.</value>
1800 <member name="P:Microsoft.Build.Framework.ITaskItem.MetadataCount">
1802 Gets the number of pieces of metadata on the item. Includes
1803 both custom and built-in metadata.
1805 <value>Count of pieces of metadata.</value>
1807 <member name="M:Microsoft.Build.Framework.ITaskItem.GetMetadata(System.String)">
1809 Allows the values of metadata on the item to be queried.
1811 <param name="metadataName">The name of the metadata to retrieve.</param>
1812 <returns>The value of the specified metadata.</returns>
1814 <member name="M:Microsoft.Build.Framework.ITaskItem.SetMetadata(System.String,System.String)">
1816 Allows a piece of custom metadata to be set on the item.
1818 <param name="metadataName">The name of the metadata to set.</param>
1819 <param name="metadataValue">The metadata value.</param>
1821 <member name="M:Microsoft.Build.Framework.ITaskItem.RemoveMetadata(System.String)">
1823 Allows the removal of custom metadata set on the item.
1825 <param name="metadataName">The name of the metadata to remove.</param>
1827 <member name="M:Microsoft.Build.Framework.ITaskItem.CopyMetadataTo(Microsoft.Build.Framework.ITaskItem)">
1829 Allows custom metadata on the item to be copied to another item.
1832 RECOMMENDED GUIDELINES FOR METHOD IMPLEMENTATIONS:
1833 1) this method should NOT copy over the item-spec
1834 2) if a particular piece of metadata already exists on the destination item, it should NOT be overwritten
1835 3) if there are pieces of metadata on the item that make no semantic sense on the destination item, they should NOT be copied
1837 <param name="destinationItem">The item to copy metadata to.</param>
1839 <member name="M:Microsoft.Build.Framework.ITaskItem.CloneCustomMetadata">
1841 Get the collection of custom metadata. This does not include built-in metadata.
1844 RECOMMENDED GUIDELINES FOR METHOD IMPLEMENTATIONS:
1845 1) this method should return a clone of the metadata
1846 2) writing to this dictionary should not be reflected in the underlying item.
1848 <returns>Dictionary of cloned metadata</returns>
1850 <member name="T:Microsoft.Build.Framework.ITaskItem2">
1852 This interface adds escaping support to the ITaskItem interface.
1855 <member name="P:Microsoft.Build.Framework.ITaskItem2.EvaluatedIncludeEscaped">
1857 Gets or sets the item include value e.g. for disk-based items this would be the file path.
1860 Taking the opportunity to fix the property name, although this doesn't
1861 make it obvious it's an improvement on ItemSpec.
1864 <member name="M:Microsoft.Build.Framework.ITaskItem2.GetMetadataValueEscaped(System.String)">
1866 Allows the values of metadata on the item to be queried.
1869 Taking the opportunity to fix the property name, although this doesn't
1870 make it obvious it's an improvement on GetMetadata.
1873 <member name="M:Microsoft.Build.Framework.ITaskItem2.SetMetadataValueLiteral(System.String,System.String)">
1875 Allows a piece of custom metadata to be set on the item. Assumes that the value passed
1876 in is unescaped, and escapes the value as necessary in order to maintain its value.
1879 Taking the opportunity to fix the property name, although this doesn't
1880 make it obvious it's an improvement on SetMetadata.
1883 <member name="M:Microsoft.Build.Framework.ITaskItem2.CloneCustomMetadataEscaped">
1885 ITaskItem2 implementation which returns a clone of the metadata on this object.
1886 Values returned are in their original escaped form.
1888 <returns>The cloned metadata, with values' escaping preserved.</returns>
1890 <member name="T:Microsoft.Build.Framework.LoadInSeparateAppDomainAttribute">
1892 This attribute is used to mark tasks that need to be run in their own app domains. The build engine will create a new app
1893 domain each time it needs to run such a task, and immediately unload it when the task is finished.
1896 <member name="M:Microsoft.Build.Framework.LoadInSeparateAppDomainAttribute.#ctor">
1898 Default constructor.
1901 <member name="T:Microsoft.Build.Framework.LoggerException">
1903 Exception that should be thrown by a logger when it cannot continue.
1904 Allows a logger to force the build to stop in an explicit way, when, for example, it
1905 receives invalid parameters, or cannot write to disk.
1908 WARNING: marking a type [Serializable] without implementing ISerializable imposes a serialization contract -- it is a
1909 promise to never change the type's fields i.e. the type is immutable; adding new fields in the next version of the type
1910 without following certain special FX guidelines, can break both forward and backward compatibility
1913 <member name="M:Microsoft.Build.Framework.LoggerException.#ctor">
1915 Default constructor.
1918 This constructor only exists to satisfy .NET coding guidelines. Use the rich constructor instead.
1921 <member name="M:Microsoft.Build.Framework.LoggerException.#ctor(System.String)">
1923 Creates an instance of this exception using the specified error message.
1925 <param name="message">Message string</param>
1927 <member name="M:Microsoft.Build.Framework.LoggerException.#ctor(System.String,System.Exception)">
1929 Creates an instance of this exception using the specified error message and inner exception.
1931 <param name="message">Message string</param>
1932 <param name="innerException">Inner exception. Can be null</param>
1934 <member name="M:Microsoft.Build.Framework.LoggerException.#ctor(System.String,System.Exception,System.String,System.String)">
1936 Creates an instance of this exception using rich error information.
1938 <param name="message">Message string</param>
1939 <param name="innerException">Inner exception. Can be null</param>
1940 <param name="errorCode">Error code</param>
1941 <param name="helpKeyword">Help keyword for host IDE. Can be null</param>
1943 <member name="P:Microsoft.Build.Framework.LoggerException.ErrorCode">
1945 Gets the error code associated with this exception's message (not the inner exception).
1947 <value>The error code string.</value>
1949 <member name="P:Microsoft.Build.Framework.LoggerException.HelpKeyword">
1951 Gets the F1-help keyword associated with this error, for the host IDE.
1953 <value>The keyword string.</value>
1955 <member name="T:Microsoft.Build.Framework.BuildEventContext">
1957 Will provide location information for an event, this is especially
1958 needed in a multi processor environment
1961 <member name="F:Microsoft.Build.Framework.BuildEventContext._nodeId">
1966 <member name="F:Microsoft.Build.Framework.BuildEventContext._targetId">
1971 <member name="F:Microsoft.Build.Framework.BuildEventContext._projectContextId">
1973 The node-unique project request context the event was in
1976 <member name="F:Microsoft.Build.Framework.BuildEventContext._taskId">
1978 Id of the task the event was caused from
1981 <member name="F:Microsoft.Build.Framework.BuildEventContext._projectInstanceId">
1983 The id of the project instance to which this event refers.
1986 <member name="F:Microsoft.Build.Framework.BuildEventContext._submissionId">
1988 The id of the submission.
1991 <member name="F:Microsoft.Build.Framework.BuildEventContext._evaluationId">
1993 The id of the evaluation
1996 <member name="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
1998 This is the original constructor. No one should ever use this except internally for backward compatibility.
2001 <member name="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
2003 Constructs a BuildEventContext with a specified project instance id.
2006 <member name="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
2008 Constructs a BuildEventContext with a specific submission id
2011 <member name="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
2013 Constructs a BuildEventContext
2016 <member name="P:Microsoft.Build.Framework.BuildEventContext.Invalid">
2018 Returns a default invalid BuildEventContext
2021 <member name="P:Microsoft.Build.Framework.BuildEventContext.EvaluationId">
2023 Retrieves the Evaluation id.
2026 <member name="P:Microsoft.Build.Framework.BuildEventContext.NodeId">
2028 NodeId where event took place
2031 <member name="P:Microsoft.Build.Framework.BuildEventContext.TargetId">
2033 Id of the target the event was in when the event was fired
2036 <member name="P:Microsoft.Build.Framework.BuildEventContext.ProjectContextId">
2038 Retrieves the Project Context id.
2041 <member name="P:Microsoft.Build.Framework.BuildEventContext.TaskId">
2043 Retrieves the task id.
2046 <member name="P:Microsoft.Build.Framework.BuildEventContext.ProjectInstanceId">
2048 Retrieves the project instance id.
2051 <member name="P:Microsoft.Build.Framework.BuildEventContext.SubmissionId">
2053 Retrieves the Submission id.
2056 <member name="P:Microsoft.Build.Framework.BuildEventContext.BuildRequestId">
2058 Retrieves the BuildRequest id. Note that this is not the same as the global request id on a BuildRequest or BuildResult.
2061 <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidProjectContextId">
2063 Indicates an invalid project context identifier.
2066 <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidTaskId">
2068 Indicates an invalid task identifier.
2071 <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidTargetId">
2073 Indicates an invalid target identifier.
2076 <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidNodeId">
2078 Indicates an invalid node identifier.
2081 <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidProjectInstanceId">
2083 Indicates an invalid project instance identifier.
2086 <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidSubmissionId">
2088 Indicates an invalid submission identifier.
2091 <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidEvaluationId">
2093 Indicates an invalid evaluation identifier.
2096 <member name="M:Microsoft.Build.Framework.BuildEventContext.GetHashCode">
2098 Retrieves a hash code for this BuildEventContext.
2102 <member name="M:Microsoft.Build.Framework.BuildEventContext.Equals(System.Object)">
2104 Compare a BuildEventContext with this BuildEventContext.
2105 A build event context is compared in the following way.
2107 1. If the object references are the same the contexts are equivalent
2108 2. If the object type is the same and the Id values in the context are the same, the contexts are equivalent
2110 <param name="obj"></param>
2113 <member name="M:Microsoft.Build.Framework.BuildEventContext.op_Equality(Microsoft.Build.Framework.BuildEventContext,Microsoft.Build.Framework.BuildEventContext)">
2115 Override == so the equals comparison using this operator will be the same as
2118 <param name="left">Left hand side operand</param>
2119 <param name="right">Right hand side operand</param>
2120 <returns>True if the object values are identical, false if they are not identical</returns>
2122 <member name="M:Microsoft.Build.Framework.BuildEventContext.op_Inequality(Microsoft.Build.Framework.BuildEventContext,Microsoft.Build.Framework.BuildEventContext)">
2124 Override != so the equals comparison using this operator will be the same as
2127 <param name="left">Left hand side operand</param>
2128 <param name="right">Right hand side operand</param>
2129 <returns>True if the object values are not identical, false if they are identical</returns>
2131 <member name="M:Microsoft.Build.Framework.BuildEventContext.InternalEquals(Microsoft.Build.Framework.BuildEventContext)">
2133 Verify the fields are identical
2135 <param name="buildEventContext">BuildEventContext to compare to this instance</param>
2136 <returns>True if the value fields are the same, false if otherwise</returns>
2138 <member name="T:Microsoft.Build.Framework.OutputAttribute">
2140 This attribute is used by task writers to designate certain task parameters as "outputs". The build engine will only allow
2141 task parameters (i.e. the task class' .NET properties) that are marked with this attribute to output data from a task. Project
2142 authors can only use parameters marked with this attribute in a task's <Output> tag. All task parameters, including those
2143 marked with this attribute, may be treated as inputs to a task by the build engine.
2146 <member name="M:Microsoft.Build.Framework.OutputAttribute.#ctor">
2148 Default constructor.
2151 <member name="T:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs">
2153 Arguments for the project evaluation finished event.
2156 <member name="M:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.#ctor">
2158 Initializes a new instance of the ProjectEvaluationFinishedEventArgs class.
2161 <member name="M:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.#ctor(System.String,System.Object[])">
2163 Initializes a new instance of the ProjectEvaluationFinishedEventArgs class.
2166 <member name="P:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.ProjectFile">
2168 Gets or sets the full path of the project that started evaluation.
2171 <member name="T:Microsoft.Build.Framework.ProjectEvaluationStartedEventArgs">
2173 Arguments for the project evaluation started event.
2176 <member name="M:Microsoft.Build.Framework.ProjectEvaluationStartedEventArgs.#ctor">
2178 Initializes a new instance of the ProjectEvaluationStartedEventArgs class.
2181 <member name="M:Microsoft.Build.Framework.ProjectEvaluationStartedEventArgs.#ctor(System.String,System.Object[])">
2183 Initializes a new instance of the ProjectEvaluationStartedEventArgs class.
2186 <member name="P:Microsoft.Build.Framework.ProjectEvaluationStartedEventArgs.ProjectFile">
2188 Gets or sets the full path of the project that started evaluation.
2191 <member name="T:Microsoft.Build.Framework.ProjectImportedEventArgs">
2193 Arguments for the project imported event.
2196 <member name="M:Microsoft.Build.Framework.ProjectImportedEventArgs.#ctor">
2198 Initializes a new instance of the ProjectImportedEventArgs class.
2201 <member name="M:Microsoft.Build.Framework.ProjectImportedEventArgs.#ctor(System.Int32,System.Int32,System.String,System.Object[])">
2203 Initializes a new instance of the ProjectImportedEventArgs class.
2206 <member name="P:Microsoft.Build.Framework.ProjectImportedEventArgs.UnexpandedProject">
2208 Gets or sets the original value of the Project attribute.
2211 <member name="P:Microsoft.Build.Framework.ProjectImportedEventArgs.ImportedProjectFile">
2213 Gets or sets the full path to the project file that was imported. If a project was not imported, the value is <code>null</code>.
2216 <member name="T:Microsoft.Build.Framework.ProjectFinishedEventArgs">
2218 Arguments for project finished events
2221 WARNING: marking a type [Serializable] without implementing
2222 ISerializable imposes a serialization contract -- it is a
2223 promise to never change the type's fields i.e. the type is
2224 immutable; adding new fields in the next version of the type
2225 without following certain special FX guidelines, can break both
2226 forward and backward compatibility
2229 <member name="M:Microsoft.Build.Framework.ProjectFinishedEventArgs.#ctor">
2234 <member name="M:Microsoft.Build.Framework.ProjectFinishedEventArgs.#ctor(System.String,System.String,System.String,System.Boolean)">
2236 This constructor allows event data to be initialized.
2237 Sender is assumed to be "MSBuild".
2239 <param name="message">text message</param>
2240 <param name="helpKeyword">help keyword </param>
2241 <param name="projectFile">name of the project</param>
2242 <param name="succeeded">true indicates project built successfully</param>
2244 <member name="M:Microsoft.Build.Framework.ProjectFinishedEventArgs.#ctor(System.String,System.String,System.String,System.Boolean,System.DateTime)">
2246 This constructor allows event data to be initialized.
2247 Sender is assumed to be "MSBuild". This constructor allows the timestamp to be set as well
2249 <param name="message">text message</param>
2250 <param name="helpKeyword">help keyword </param>
2251 <param name="projectFile">name of the project</param>
2252 <param name="succeeded">true indicates project built successfully</param>
2253 <param name="eventTimestamp">Timestamp when the event was created</param>
2255 <member name="P:Microsoft.Build.Framework.ProjectFinishedEventArgs.ProjectFile">
2260 <member name="P:Microsoft.Build.Framework.ProjectFinishedEventArgs.Succeeded">
2262 True if project built successfully, false otherwise
2265 <member name="T:Microsoft.Build.Framework.ProjectStartedEventArgs">
2267 Arguments for project started events
2270 WARNING: marking a type [Serializable] without implementing
2271 ISerializable imposes a serialization contract -- it is a
2272 promise to never change the type's fields i.e. the type is
2273 immutable; adding new fields in the next version of the type
2274 without following certain special FX guidelines, can break both
2275 forward and backward compatibility
2278 <member name="F:Microsoft.Build.Framework.ProjectStartedEventArgs.InvalidProjectId">
2280 Indicates an invalid project identifier.
2283 <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.#ctor">
2288 <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Collections.IEnumerable,System.Collections.IEnumerable)">
2290 This constructor allows event data to be initialized.
2291 Sender is assumed to be "MSBuild".
2293 <param name="message">text message</param>
2294 <param name="helpKeyword">help keyword </param>
2295 <param name="projectFile">project name</param>
2296 <param name="targetNames">targets we are going to build (empty indicates default targets)</param>
2297 <param name="properties">list of properties</param>
2298 <param name="items">list of items</param>
2300 <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.#ctor(System.Int32,System.String,System.String,System.String,System.String,System.Collections.IEnumerable,System.Collections.IEnumerable,Microsoft.Build.Framework.BuildEventContext)">
2302 This constructor allows event data to be initialized.
2303 Sender is assumed to be "MSBuild".
2305 <param name="projectId">project id</param>
2306 <param name="message">text message</param>
2307 <param name="helpKeyword">help keyword </param>
2308 <param name="projectFile">project name</param>
2309 <param name="targetNames">targets we are going to build (empty indicates default targets)</param>
2310 <param name="properties">list of properties</param>
2311 <param name="items">list of items</param>
2312 <param name="parentBuildEventContext">event context info for the parent project</param>
2314 <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.#ctor(System.Int32,System.String,System.String,System.String,System.String,System.Collections.IEnumerable,System.Collections.IEnumerable,Microsoft.Build.Framework.BuildEventContext,System.Collections.Generic.IDictionary{System.String,System.String},System.String)">
2316 This constructor allows event data to be initialized.
2317 Sender is assumed to be "MSBuild".
2319 <param name="projectId">project id</param>
2320 <param name="message">text message</param>
2321 <param name="helpKeyword">help keyword </param>
2322 <param name="projectFile">project name</param>
2323 <param name="targetNames">targets we are going to build (empty indicates default targets)</param>
2324 <param name="properties">list of properties</param>
2325 <param name="items">list of items</param>
2326 <param name="parentBuildEventContext">event context info for the parent project</param>
2327 <param name="globalProperties">An <see cref="T:System.Collections.Generic.IDictionary`2"/> containing global properties.</param>
2328 <param name="toolsVersion">The tools version.</param>
2330 <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Collections.IEnumerable,System.Collections.IEnumerable,System.DateTime)">
2332 This constructor allows event data to be initialized. Also the timestamp can be set
2333 Sender is assumed to be "MSBuild".
2335 <param name="message">text message</param>
2336 <param name="helpKeyword">help keyword </param>
2337 <param name="projectFile">project name</param>
2338 <param name="targetNames">targets we are going to build (empty indicates default targets)</param>
2339 <param name="properties">list of properties</param>
2340 <param name="items">list of items</param>
2341 <param name="eventTimestamp">The <see cref="T:System.DateTime"/> of the event.</param>
2343 <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.#ctor(System.Int32,System.String,System.String,System.String,System.String,System.Collections.IEnumerable,System.Collections.IEnumerable,Microsoft.Build.Framework.BuildEventContext,System.DateTime)">
2345 This constructor allows event data to be initialized.
2346 Sender is assumed to be "MSBuild".
2348 <param name="projectId">project id</param>
2349 <param name="message">text message</param>
2350 <param name="helpKeyword">help keyword </param>
2351 <param name="projectFile">project name</param>
2352 <param name="targetNames">targets we are going to build (empty indicates default targets)</param>
2353 <param name="properties">list of properties</param>
2354 <param name="items">list of items</param>
2355 <param name="parentBuildEventContext">event context info for the parent project</param>
2356 <param name="eventTimestamp">The <see cref="T:System.DateTime"/> of the event.</param>
2358 <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.ProjectId">
2360 Gets the idenifier of the project.
2363 <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.ParentProjectBuildEventContext">
2365 Event context information, where the event was fired from in terms of the build location
2368 <member name="F:Microsoft.Build.Framework.ProjectStartedEventArgs.projectFile">
2370 The name of the project file
2373 <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.ProjectFile">
2378 <member name="F:Microsoft.Build.Framework.ProjectStartedEventArgs.targetNames">
2380 Targets that we will build in the project
2383 <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.TargetNames">
2385 Targets that we will build in the project
2388 <member name="F:Microsoft.Build.Framework.ProjectStartedEventArgs.globalProperties">
2390 Gets the set of global properties used to evaluate this project.
2393 <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.GlobalProperties">
2395 Gets the set of global properties used to evaluate this project.
2398 <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.ToolsVersion">
2400 Gets the tools version used to evaluate this project.
2403 <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.Properties">
2405 List of properties in this project. This is a live, read-only list.
2408 <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.Items">
2410 List of items in this project. This is a live, read-only list.
2413 <member name="T:Microsoft.Build.Framework.SdkReference">
2415 Represents a software development kit (SDK) that is referenced in a <Project /> or <Import /> element.
2418 <member name="M:Microsoft.Build.Framework.SdkReference.#ctor(System.String,System.String,System.String)">
2420 Initializes a new instance of the SdkReference class.
2422 <param name="name">The name of the SDK.</param>
2423 <param name="version">The version of the SDK.</param>
2424 <param name="minimumVersion">Minimum SDK version required by the project.</param>
2426 <member name="P:Microsoft.Build.Framework.SdkReference.Name">
2428 Gets the name of the SDK.
2431 <member name="P:Microsoft.Build.Framework.SdkReference.Version">
2433 Gets the version of the SDK.
2436 <member name="P:Microsoft.Build.Framework.SdkReference.MinimumVersion">
2438 Gets the minimum version required. This value is specified by the project to indicate the minimum version of the
2439 SDK that is required in order to build. This is useful in order to produce an error message if a name match can
2440 be found but no acceptable version could be resolved.
2443 <member name="M:Microsoft.Build.Framework.SdkReference.Equals(Microsoft.Build.Framework.SdkReference)">
2446 <param name="other"></param>
2449 <member name="M:Microsoft.Build.Framework.SdkReference.TryParse(System.String,Microsoft.Build.Framework.SdkReference@)">
2451 Attempts to parse the specified string as a <see cref="T:Microsoft.Build.Framework.SdkReference" />. The expected format is:
2452 SDK, SDK/Version, or SDK/min=MinimumVersion
2453 Values are not required to specify a version or MinimumVersion.
2455 <param name="sdk">An SDK name and version to parse in the format "SDK/Version,min=MinimumVersion".</param>
2456 <param name="sdkReference">A parsed <see cref="T:Microsoft.Build.Framework.SdkReference" /> if the specified value is a valid SDK name.</param>
2457 <returns><code>true</code> if the SDK name was successfully parsed, otherwise <code>false</code>.</returns>
2459 <member name="M:Microsoft.Build.Framework.SdkReference.Equals(System.Object)">
2462 <member name="M:Microsoft.Build.Framework.SdkReference.GetHashCode">
2465 <member name="M:Microsoft.Build.Framework.SdkReference.ToString">
2468 <member name="T:Microsoft.Build.Framework.RequiredAttribute">
2470 This class defines the attribute that a task writer can apply to a task's property to declare the property to be a
2474 <member name="M:Microsoft.Build.Framework.RequiredAttribute.#ctor">
2476 Default constructor.
2479 <member name="T:Microsoft.Build.Framework.RequiredRuntimeAttribute">
2481 When marked with the RequiredRuntimeAttribute, a task indicates that it has stricter
2482 runtime requirements than a regular task - this tells MSBuild that it will need to potentially
2483 launch a separate process for that task if the current runtime does not match the version requirement.
2484 This attribute is currently non-functional since there is only one version of the CLR that is
2485 capable of running MSBuild v2.0 or v3.5 - the runtime v2.0
2488 <member name="M:Microsoft.Build.Framework.RequiredRuntimeAttribute.#ctor(System.String)">
2490 Constructor taking a version, such as "v2.0".
2493 <member name="P:Microsoft.Build.Framework.RequiredRuntimeAttribute.RuntimeVersion">
2495 Returns the runtime version the attribute was constructed with,
2499 <member name="T:Microsoft.Build.Framework.RunInMTAAttribute">
2501 This attribute is used to mark a task class as explicitly not being required to run in the STA for COM.
2504 <member name="M:Microsoft.Build.Framework.RunInMTAAttribute.#ctor">
2506 Default constructor.
2509 <member name="T:Microsoft.Build.Framework.RunInSTAAttribute">
2511 This attribute is used to mark a task class as being required to run in a Single Threaded Apartment for COM.
2514 <member name="M:Microsoft.Build.Framework.RunInSTAAttribute.#ctor">
2516 Default constructor.
2519 <member name="T:Microsoft.Build.Framework.SdkLogger">
2521 An abstract interface class to providing real-time logging and status while resolving
2525 <member name="M:Microsoft.Build.Framework.SdkLogger.LogMessage(System.String,Microsoft.Build.Framework.MessageImportance)">
2527 Log a build message to MSBuild.
2529 <param name="message">Message string.</param>
2530 <param name="messageImportance">Optional message importances. Default to low.</param>
2532 <member name="T:Microsoft.Build.Framework.SdkResolver">
2534 An abstract interface for classes that can resolve a Software Development Kit (SDK).
2537 <member name="P:Microsoft.Build.Framework.SdkResolver.Name">
2539 Name of the SDK resolver to be displayed in build output log.
2542 <member name="P:Microsoft.Build.Framework.SdkResolver.Priority">
2544 Gets the self-described resolution priority order. MSBuild will sort resolvers
2548 <member name="M:Microsoft.Build.Framework.SdkResolver.Resolve(Microsoft.Build.Framework.SdkReference,Microsoft.Build.Framework.SdkResolverContext,Microsoft.Build.Framework.SdkResultFactory)">
2550 Resolves the specified SDK reference.
2552 <param name="sdkReference">A <see cref="T:Microsoft.Build.Framework.SdkReference" /> containing the referenced SDKs be resolved.</param>
2553 <param name="resolverContext">Context for resolving the SDK.</param>
2554 <param name="factory">Factory class to create an <see cref="T:Microsoft.Build.Framework.SdkResult" /></param>
2556 An <see cref="T:Microsoft.Build.Framework.SdkResult" /> containing the resolved SDKs or associated error / reason
2557 the SDK could not be resolved.
2559 Note: You must use the <see cref="T:Microsoft.Build.Framework.SdkResultFactory" /> to return a result.
2563 <member name="T:Microsoft.Build.Framework.SdkResolverContext">
2565 Context used by an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> to resolve an SDK.
2568 <member name="P:Microsoft.Build.Framework.SdkResolverContext.Logger">
2570 Logger to log real-time messages back to MSBuild.
2573 <member name="P:Microsoft.Build.Framework.SdkResolverContext.ProjectFilePath">
2575 Path to the project file being built.
2578 <member name="P:Microsoft.Build.Framework.SdkResolverContext.SolutionFilePath">
2580 Path to the solution file being built, if known. May be null.
2583 <member name="P:Microsoft.Build.Framework.SdkResolverContext.MSBuildVersion">
2585 Version of MSBuild currently running.
2587 File version based on commit height from our public git repository. This is informational
2588 and not equal to the assembly version.
2592 <member name="T:Microsoft.Build.Framework.SdkResult">
2594 An abstract interface class to indicate SDK resolver success or failure.
2596 Note: Use <see cref="T:Microsoft.Build.Framework.SdkResultFactory" /> to create instances of this class. Do not
2597 inherit from this class.
2601 <member name="P:Microsoft.Build.Framework.SdkResult.Success">
2603 Indicates the resolution was successful.
2606 <member name="T:Microsoft.Build.Framework.SdkResultFactory">
2608 An abstract interface class provided to <see cref="T:Microsoft.Build.Framework.SdkResolver" /> to create an
2609 <see cref="T:Microsoft.Build.Framework.SdkResult" /> object indicating success / failure.
2612 <member name="M:Microsoft.Build.Framework.SdkResultFactory.IndicateSuccess(System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
2614 Create an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> object indicating success resolving the SDK.
2616 <param name="path">Path to the SDK.</param>
2617 <param name="version">Version of the SDK that was resolved.</param>
2618 <param name="warnings">Optional warnings to display during resolution.</param>
2621 <member name="M:Microsoft.Build.Framework.SdkResultFactory.IndicateFailure(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
2623 Create an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> object indicating failure resolving the SDK.
2625 <param name="errors">
2626 Errors / reasons the SDK could not be resolved. Will be logged as a
2627 build error if no other SdkResolvers were able to indicate success.
2629 <param name="warnings"></param>
2632 <member name="T:Microsoft.Build.Framework.TargetFinishedEventArgs">
2634 Arguments for target finished events
2637 WARNING: marking a type [Serializable] without implementing
2638 ISerializable imposes a serialization contract -- it is a
2639 promise to never change the type's fields i.e. the type is
2640 immutable; adding new fields in the next version of the type
2641 without following certain special FX guidelines, can break both
2642 forward and backward compatibility
2645 <member name="M:Microsoft.Build.Framework.TargetFinishedEventArgs.#ctor">
2650 <member name="M:Microsoft.Build.Framework.TargetFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean)">
2652 This constructor allows event data to be initialized.
2653 Sender is assumed to be "MSBuild".
2655 <param name="message">text message</param>
2656 <param name="helpKeyword">help keyword </param>
2657 <param name="targetName">target name</param>
2658 <param name="projectFile">project file</param>
2659 <param name="targetFile">file in which the target is defined</param>
2660 <param name="succeeded">true if target built successfully</param>
2662 <member name="M:Microsoft.Build.Framework.TargetFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Collections.IEnumerable)">
2664 This constructor allows event data to be initialized.
2665 Sender is assumed to be "MSBuild".
2667 <param name="message">text message</param>
2668 <param name="helpKeyword">help keyword </param>
2669 <param name="targetName">target name</param>
2670 <param name="projectFile">project file</param>
2671 <param name="targetFile">file in which the target is defined</param>
2672 <param name="succeeded">true if target built successfully</param>
2673 <param name="targetOutputs">Target output items for the target. If batching will be null for everything except for the last target in the batch</param>
2675 <member name="M:Microsoft.Build.Framework.TargetFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.DateTime,System.Collections.IEnumerable)">
2677 This constructor allows event data to be initialized including the timestamp when the event was created.
2678 Sender is assumed to be "MSBuild".
2680 <param name="message">text message</param>
2681 <param name="helpKeyword">help keyword </param>
2682 <param name="targetName">target name</param>
2683 <param name="projectFile">project file</param>
2684 <param name="targetFile">file in which the target is defined</param>
2685 <param name="succeeded">true if target built successfully</param>
2686 <param name="eventTimestamp">Timestamp when the event was created</param>
2687 <param name="targetOutputs">An <see cref="T:System.Collections.IEnumerable"/> containing the outputs of the target.</param>
2689 <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.TargetName">
2694 <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.Succeeded">
2696 True if target built successfully, false otherwise
2699 <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.ProjectFile">
2701 Project file associated with event.
2704 <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.TargetFile">
2706 File where this target was declared.
2709 <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.TargetOutputs">
2714 <member name="T:Microsoft.Build.Framework.TargetStartedEventArgs">
2716 Arguments for target started events
2719 WARNING: marking a type [Serializable] without implementing
2720 ISerializable imposes a serialization contract -- it is a
2721 promise to never change the type's fields i.e. the type is
2722 immutable; adding new fields in the next version of the type
2723 without following certain special FX guidelines, can break both
2724 forward and backward compatibility
2727 <member name="M:Microsoft.Build.Framework.TargetStartedEventArgs.#ctor">
2732 <member name="M:Microsoft.Build.Framework.TargetStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String)">
2734 This constructor allows event data to be initialized.
2735 Sender is assumed to be "MSBuild".
2737 <param name="message">text message</param>
2738 <param name="helpKeyword">help keyword </param>
2739 <param name="targetName">target name</param>
2740 <param name="projectFile">project file</param>
2741 <param name="targetFile">file in which the target is defined</param>
2743 <member name="M:Microsoft.Build.Framework.TargetStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.DateTime)">
2745 This constructor allows event data to be initialized including the timestamp when the event was created.
2747 <param name="message">text message</param>
2748 <param name="helpKeyword">help keyword </param>
2749 <param name="targetName">target name</param>
2750 <param name="projectFile">project file</param>
2751 <param name="targetFile">file in which the target is defined</param>
2752 <param name="parentTarget">The part of the target.</param>
2753 <param name="eventTimestamp">Timestamp when the event was created</param>
2755 <member name="P:Microsoft.Build.Framework.TargetStartedEventArgs.TargetName">
2760 <member name="P:Microsoft.Build.Framework.TargetStartedEventArgs.ParentTarget">
2762 Target which caused this target to build
2765 <member name="P:Microsoft.Build.Framework.TargetStartedEventArgs.ProjectFile">
2767 Project file associated with event.
2770 <member name="P:Microsoft.Build.Framework.TargetStartedEventArgs.TargetFile">
2772 File where this target was declared.
2775 <member name="T:Microsoft.Build.Framework.TaskCommandLineEventArgs">
2777 This class is used by tasks to log their command lines. This class extends
2778 <see cref="T:Microsoft.Build.Framework.BuildMessageEventArgs"/> so that command lines can be logged as
2779 messages. Logging a command line is only relevant for tasks that wrap an
2780 underlying executable/tool, or emulate a shell command. Tasks that have
2781 no command line equivalent should not raise this extended message event.
2784 WARNING: marking a type [Serializable] without implementing ISerializable
2785 imposes a serialization contract -- it is a promise to never change the
2786 type's fields i.e. the type is immutable; adding new fields in the next
2787 version of the type without following certain special FX guidelines, can
2788 break both forward and backward compatibility
2791 <member name="M:Microsoft.Build.Framework.TaskCommandLineEventArgs.#ctor">
2793 Default (family) constructor.
2796 <member name="M:Microsoft.Build.Framework.TaskCommandLineEventArgs.#ctor(System.String,System.String,Microsoft.Build.Framework.MessageImportance)">
2798 Creates an instance of this class for the given task command line.
2800 <param name="commandLine">The command line used by a task to launch
2801 its underlying tool/executable.</param>
2802 <param name="taskName">The name of the task raising this event.</param>
2803 <param name="importance">Importance of command line -- controls whether
2804 the command line will be displayed by less verbose loggers.</param>
2806 <member name="M:Microsoft.Build.Framework.TaskCommandLineEventArgs.#ctor(System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime)">
2808 Creates an instance of this class for the given task command line. This constructor allows the timestamp to be set
2810 <param name="commandLine">The command line used by a task to launch
2811 its underlying tool/executable.</param>
2812 <param name="taskName">The name of the task raising this event.</param>
2813 <param name="importance">Importance of command line -- controls whether
2814 the command line will be displayed by less verbose loggers.</param>
2815 <param name="eventTimestamp">Timestamp when the event was created</param>
2817 <member name="P:Microsoft.Build.Framework.TaskCommandLineEventArgs.CommandLine">
2819 Gets the task command line associated with this event.
2822 <member name="P:Microsoft.Build.Framework.TaskCommandLineEventArgs.TaskName">
2824 Gets the name of the task that raised this event.
2827 <member name="T:Microsoft.Build.Framework.TaskFinishedEventArgs">
2829 Arguments for task finished events
2832 WARNING: marking a type [Serializable] without implementing
2833 ISerializable imposes a serialization contract -- it is a
2834 promise to never change the type's fields i.e. the type is
2835 immutable; adding new fields in the next version of the type
2836 without following certain special FX guidelines, can break both
2837 forward and backward compatibility
2840 <member name="M:Microsoft.Build.Framework.TaskFinishedEventArgs.#ctor">
2845 <member name="M:Microsoft.Build.Framework.TaskFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean)">
2847 This constructor allows event data to be initialized.
2848 Sender is assumed to be "MSBuild".
2850 <param name="message">text message</param>
2851 <param name="helpKeyword">help keyword </param>
2852 <param name="projectFile">project file</param>
2853 <param name="taskFile">file in which the task is defined</param>
2854 <param name="taskName">task name</param>
2855 <param name="succeeded">true indicates task succeed</param>
2857 <member name="M:Microsoft.Build.Framework.TaskFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.DateTime)">
2859 This constructor allows event data to be initialized and the timestamp to be set
2860 Sender is assumed to be "MSBuild".
2862 <param name="message">text message</param>
2863 <param name="helpKeyword">help keyword </param>
2864 <param name="projectFile">project file</param>
2865 <param name="taskFile">file in which the task is defined</param>
2866 <param name="taskName">task name</param>
2867 <param name="succeeded">true indicates task succeed</param>
2868 <param name="eventTimestamp">Timestamp when event was created</param>
2870 <member name="P:Microsoft.Build.Framework.TaskFinishedEventArgs.TaskName">
2875 <member name="P:Microsoft.Build.Framework.TaskFinishedEventArgs.Succeeded">
2877 True if target built successfully, false otherwise
2880 <member name="P:Microsoft.Build.Framework.TaskFinishedEventArgs.ProjectFile">
2882 Project file associated with event.
2885 <member name="P:Microsoft.Build.Framework.TaskFinishedEventArgs.TaskFile">
2887 MSBuild file where this task was defined.
2890 <member name="T:Microsoft.Build.Framework.TaskPropertyInfo">
2892 Class which represents the parameter information from the using task as a strongly typed class.
2895 <member name="M:Microsoft.Build.Framework.TaskPropertyInfo.#ctor(System.String,System.Type,System.Boolean,System.Boolean)">
2897 Encapsulates a list of parameters declared in the UsingTask
2899 <param name="name">Name of the parameter</param>
2900 <param name="typeOfParameter">The actual type of the parameter</param>
2901 <param name="output">True if the parameter is both an output and and input parameter. False if the parameter is only an input parameter</param>
2902 <param name="required">True if the parameter must be supplied to each invocation of the task.</param>
2904 <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.PropertyType">
2906 The type of the property
2909 <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.Name">
2911 Name of the property
2914 <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.Output">
2916 This task parameter is an output parameter (analogous to [Output] attribute)
2919 <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.Required">
2921 This task parameter is required (analogous to the [Required] attribute)
2924 <member name="T:Microsoft.Build.Framework.TaskStartedEventArgs">
2926 Arguments for task started events
2929 WARNING: marking a type [Serializable] without implementing
2930 ISerializable imposes a serialization contract -- it is a
2931 promise to never change the type's fields i.e. the type is
2932 immutable; adding new fields in the next version of the type
2933 without following certain special FX guidelines, can break both
2934 forward and backward compatibility
2937 <member name="M:Microsoft.Build.Framework.TaskStartedEventArgs.#ctor">
2942 <member name="M:Microsoft.Build.Framework.TaskStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String)">
2944 This constructor allows event data to be initialized.
2945 Sender is assumed to be "MSBuild".
2947 <param name="message">text message</param>
2948 <param name="helpKeyword">help keyword </param>
2949 <param name="projectFile">project file</param>
2950 <param name="taskFile">file in which the task is defined</param>
2951 <param name="taskName">task name</param>
2953 <member name="M:Microsoft.Build.Framework.TaskStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.DateTime)">
2955 This constructor allows event data to be initialized.
2956 Sender is assumed to be "MSBuild".
2958 <param name="message">text message</param>
2959 <param name="helpKeyword">help keyword </param>
2960 <param name="projectFile">project file</param>
2961 <param name="taskFile">file in which the task is defined</param>
2962 <param name="taskName">task name</param>
2963 <param name="eventTimestamp">Timestamp when event was created</param>
2965 <member name="P:Microsoft.Build.Framework.TaskStartedEventArgs.TaskName">
2970 <member name="P:Microsoft.Build.Framework.TaskStartedEventArgs.ProjectFile">
2972 Project file associated with event.
2975 <member name="P:Microsoft.Build.Framework.TaskStartedEventArgs.TaskFile">
2977 MSBuild file where this task was defined.
2980 <member name="T:Microsoft.Build.Framework.TelemetryEventArgs">
2982 Arguments for telemetry events.
2985 <member name="P:Microsoft.Build.Framework.TelemetryEventArgs.EventName">
2987 Gets or sets the name of the event.
2990 <member name="P:Microsoft.Build.Framework.TelemetryEventArgs.Properties">
2992 Gets or sets a list of properties associated with the event.