portable-devtools / msbuild_packages /Microsoft.Build.Framework.17.10.4 /lib /net8.0 /Microsoft.Build.Framework.xml
| <doc> | |
| <assembly> | |
| <name>Microsoft.Build.Framework</name> | |
| </assembly> | |
| <members> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary"> | |
| <summary> | |
| Provides methods for creating a segmented dictionary that is immutable; meaning it cannot be changed once it is | |
| created. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2"> | |
| <summary> | |
| Represents a segmented dictionary that is immutable; meaning it cannot be changed once it is created. | |
| </summary> | |
| <remarks> | |
| <para>There are different scenarios best for <see cref="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2"/> and others | |
| best for <see cref="T:System.Collections.Immutable.ImmutableDictionary`2"/>.</para> | |
| <para>In general, <see cref="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2"/> is applicable in scenarios most like | |
| the scenarios where <see cref="T:System.Collections.Immutable.ImmutableArray`1"/> is applicable, and | |
| <see cref="T:System.Collections.Immutable.ImmutableDictionary`2"/> is applicable in scenarios most like the scenarios where | |
| <see cref="T:System.Collections.Immutable.ImmutableList`1"/> is applicable.</para> | |
| <para>The following table summarizes the performance characteristics of | |
| <see cref="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2"/>:</para> | |
| <list type="table"> | |
| <item> | |
| <description>Operation</description> | |
| <description><see cref="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2"/> Complexity</description> | |
| <description><see cref="T:System.Collections.Immutable.ImmutableDictionary`2"/> Complexity</description> | |
| <description>Comments</description> | |
| </item> | |
| <item> | |
| <description>Item</description> | |
| <description>O(1)</description> | |
| <description>O(log n)</description> | |
| <description>Directly index into the underlying segmented dictionary</description> | |
| </item> | |
| <item> | |
| <description>Add()</description> | |
| <description>O(n)</description> | |
| <description>O(log n)</description> | |
| <description>Requires creating a new segmented dictionary</description> | |
| </item> | |
| </list> | |
| <para>This type is backed by segmented arrays to avoid using the Large Object Heap without impacting algorithmic | |
| complexity.</para> | |
| </remarks> | |
| <typeparam name="TKey">The type of the keys in the dictionary.</typeparam> | |
| <typeparam name="TValue">The type of the values in the dictionary.</typeparam> | |
| <devremarks> | |
| <para>This type has a documented contract of being exactly one reference-type field in size. Our own | |
| <see cref="T:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked"/> class depends on it, as well as others externally.</para> | |
| <para><strong>IMPORTANT NOTICE FOR MAINTAINERS AND REVIEWERS:</strong></para> | |
| <para>This type should be thread-safe. As a struct, it cannot protect its own fields from being changed from one | |
| thread while its members are executing on other threads because structs can change <em>in place</em> simply by | |
| reassigning the field containing this struct. Therefore it is extremely important that <strong>⚠⚠ Every member | |
| should only dereference <c>this</c> ONCE ⚠⚠</strong>. If a member needs to reference the | |
| <see cref="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2._dictionary"/> field, that counts as a dereference of <c>this</c>. Calling other instance members | |
| (properties or methods) also counts as dereferencing <c>this</c>. Any member that needs to use <c>this</c> more | |
| than once must instead assign <c>this</c> to a local variable and use that for the rest of the code instead. | |
| This effectively copies the one field in the struct to a local variable so that it is insulated from other | |
| threads.</para> | |
| </devremarks> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2.Builder._dictionary"> | |
| <summary> | |
| The immutable collection this builder is based on. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2.Builder._mutableDictionary"> | |
| <summary> | |
| The current mutable collection this builder is operating on. This field is initialized to a copy of | |
| <see cref="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2.Builder._dictionary"/> the first time a change is made. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2.Enumerator.ReturnType.KeyValuePair"> | |
| <summary> | |
| The return value from the implementation of <see cref="M:System.Collections.IEnumerable.GetEnumerator"/> is | |
| <see cref="T:System.Collections.Generic.KeyValuePair`2"/>. This is the return value for most instances of this | |
| enumerator. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2.Enumerator.ReturnType.DictionaryEntry"> | |
| <summary> | |
| The return value from the implementation of <see cref="M:System.Collections.IEnumerable.GetEnumerator"/> is | |
| <see cref="T:System.Collections.DictionaryEntry"/>. This is the return value for instances of this | |
| enumerator created by the <see cref="M:System.Collections.IDictionary.GetEnumerator"/> implementation in | |
| <see cref="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2"/>. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary`2.PrivateInterlocked"> | |
| <summary> | |
| Private helper class for use only by <see cref="T:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked"/>. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList.Create``1"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList.Create``1"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList.Create``1(``0)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList.Create``1(``0)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList.Create``1(``0[])"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList.Create``1(``0[])"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList.CreateBuilder``1"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList.CreateBuilder``1"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList.CreateRange``1(System.Collections.Generic.IEnumerable{``0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList.CreateRange``1(System.Collections.Generic.IEnumerable{``0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList.ToImmutableSegmentedList``1(System.Collections.Generic.IEnumerable{``0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList.ToImmutableList``1(System.Collections.Generic.IEnumerable{``0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList.ToImmutableSegmentedList``1(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0}.Builder)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList.ToImmutableList``1(System.Collections.Immutable.ImmutableList{``0}.Builder)"/> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1"> | |
| <summary> | |
| Represents a segmented list that is immutable; meaning it cannot be changed once it is created. | |
| </summary> | |
| <remarks> | |
| <para>There are different scenarios best for <see cref="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1"/> and others | |
| best for <see cref="T:System.Collections.Immutable.ImmutableList`1"/>.</para> | |
| <para>The following table summarizes the performance characteristics of | |
| <see cref="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1"/>:</para> | |
| <list type="table"> | |
| <item> | |
| <description>Operation</description> | |
| <description><see cref="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1"/> Complexity</description> | |
| <description><see cref="T:System.Collections.Immutable.ImmutableList`1"/> Complexity</description> | |
| <description>Comments</description> | |
| </item> | |
| <item> | |
| <description>Item</description> | |
| <description>O(1)</description> | |
| <description>O(log n)</description> | |
| <description>Directly index into the underlying segmented list</description> | |
| </item> | |
| <item> | |
| <description>Add()</description> | |
| <description>Currently O(n), but could be O(1) with a relatively large constant</description> | |
| <description>O(log n)</description> | |
| <description>Currently requires creating a new segmented list, but could be modified to only clone the segments with changes</description> | |
| </item> | |
| <item> | |
| <description>Insert()</description> | |
| <description>O(n)</description> | |
| <description>O(log n)</description> | |
| <description>Requires creating a new segmented list and cloning all impacted segments</description> | |
| </item> | |
| </list> | |
| <para>This type is backed by segmented arrays to avoid using the Large Object Heap without impacting algorithmic | |
| complexity.</para> | |
| </remarks> | |
| <typeparam name="T">The type of the value in the list.</typeparam> | |
| <devremarks> | |
| <para>This type has a documented contract of being exactly one reference-type field in size. Our own | |
| <see cref="T:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked"/> class depends on it, as well as others externally.</para> | |
| <para><strong>IMPORTANT NOTICE FOR MAINTAINERS AND REVIEWERS:</strong></para> | |
| <para>This type should be thread-safe. As a struct, it cannot protect its own fields from being changed from one | |
| thread while its members are executing on other threads because structs can change <em>in place</em> simply by | |
| reassigning the field containing this struct. Therefore it is extremely important that <strong>⚠⚠ Every member | |
| should only dereference <c>this</c> ONCE ⚠⚠</strong>. If a member needs to reference the | |
| <see cref="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1._list"/> field, that counts as a dereference of <c>this</c>. Calling other instance members | |
| (properties or methods) also counts as dereferencing <c>this</c>. Any member that needs to use <c>this</c> more | |
| than once must instead assign <c>this</c> to a local variable and use that for the rest of the code instead. | |
| This effectively copies the one field in the struct to a local variable so that it is insulated from other | |
| threads.</para> | |
| </devremarks> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder._builder"> | |
| <summary> | |
| The immutable collection this builder is based on. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.ItemRef(System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.ItemRef(System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.AddRange(System.Collections.Generic.IEnumerable{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.AddRange(System.Collections.Generic.IEnumerable{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.BinarySearch(`0)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.BinarySearch(`0)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.BinarySearch(`0,System.Collections.Generic.IComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.BinarySearch(`0,System.Collections.Generic.IComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.BinarySearch(System.Int32,System.Int32,`0,System.Collections.Generic.IComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.BinarySearch(System.Int32,System.Int32,`0,System.Collections.Generic.IComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.ConvertAll``1(System.Converter{`0,``0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.ConvertAll``1(System.Func{`0,``0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.CopyTo(`0[])"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.CopyTo(`0[])"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.CopyTo(System.Int32,`0[],System.Int32,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.CopyTo(System.Int32,`0[],System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.Exists(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.Exists(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.Find(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.Find(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.FindAll(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.FindAll(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.FindIndex(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.FindIndex(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.FindIndex(System.Int32,System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.FindIndex(System.Int32,System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.FindIndex(System.Int32,System.Int32,System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.FindIndex(System.Int32,System.Int32,System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.FindLast(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.FindLast(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.FindLastIndex(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.FindLastIndex(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.FindLastIndex(System.Int32,System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.FindLastIndex(System.Int32,System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.ForEach(System.Action{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.ForEach(System.Action{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.GetEnumerator"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.GetEnumerator"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.GetRange(System.Int32,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.GetRange(System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.IndexOf(`0,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.IndexOf(`0,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.IndexOf(`0,System.Int32,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.IndexOf(`0,System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.IndexOf(`0,System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.IndexOf(`0,System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.LastIndexOf(`0)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.LastIndexOf(`0)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.LastIndexOf(`0,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.LastIndexOf(`0,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.LastIndexOf(`0,System.Int32,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.LastIndexOf(`0,System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.LastIndexOf(`0,System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.LastIndexOf(`0,System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.RemoveAll(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.RemoveAll(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.Reverse"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.Reverse"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.Reverse(System.Int32,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.Reverse(System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.Sort"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.Sort"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.Sort(System.Collections.Generic.IComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.Sort(System.Collections.Generic.IComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.Sort(System.Comparison{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.Sort(System.Comparison{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.ToImmutable"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.ToImmutable"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Builder.TrueForAll(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Builder.TrueForAll(System.Predicate{`0})"/> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.PrivateInterlocked"> | |
| <summary> | |
| Private helper class for use only by <see cref="T:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked"/>. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.ValueBuilder._list"> | |
| <summary> | |
| The immutable collection this builder is based on. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.ValueBuilder._mutableList"> | |
| <summary> | |
| The current mutable collection this builder is operating on. This field is initialized to a copy of | |
| <see cref="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.ValueBuilder._list"/> the first time a change is made. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Empty"> | |
| <inheritdoc cref="F:System.Collections.Immutable.ImmutableList`1.Empty"/> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.IsEmpty"> | |
| <inheritdoc cref="P:System.Collections.Immutable.ImmutableList`1.IsEmpty"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.ItemRef(System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.ItemRef(System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Add(`0)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Add(`0)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.BinarySearch(`0)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.BinarySearch(`0)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.BinarySearch(`0,System.Collections.Generic.IComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.BinarySearch(`0,System.Collections.Generic.IComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.BinarySearch(System.Int32,System.Int32,`0,System.Collections.Generic.IComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.BinarySearch(System.Int32,System.Int32,`0,System.Collections.Generic.IComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Clear"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Clear"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.ConvertAll``1(System.Converter{`0,``0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.ConvertAll``1(System.Func{`0,``0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.CopyTo(`0[])"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.CopyTo(`0[])"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Exists(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Exists(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Find(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Find(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.FindAll(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.FindAll(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.FindIndex(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.FindIndex(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.FindIndex(System.Int32,System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.FindIndex(System.Int32,System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.FindIndex(System.Int32,System.Int32,System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.FindIndex(System.Int32,System.Int32,System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.FindLast(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.FindLast(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.FindLastIndex(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.FindLastIndex(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.FindLastIndex(System.Int32,System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.FindLastIndex(System.Int32,System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.ForEach(System.Action{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.ForEach(System.Action{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.GetEnumerator"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.GetEnumerator"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.GetRange(System.Int32,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.GetRange(System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Insert(System.Int32,`0)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Insert(System.Int32,`0)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Remove(`0)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Remove(`0)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Remove(`0,System.Collections.Generic.IEqualityComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Remove(`0,System.Collections.Generic.IEqualityComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.RemoveAll(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.RemoveAll(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.RemoveAt(System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.RemoveAt(System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.RemoveRange(System.Collections.Generic.IEnumerable{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.RemoveRange(System.Collections.Generic.IEnumerable{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.RemoveRange(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEqualityComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.RemoveRange(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEqualityComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.RemoveRange(System.Int32,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.RemoveRange(System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Replace(`0,`0)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Replace(`0,`0)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Replace(`0,`0,System.Collections.Generic.IEqualityComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Replace(`0,`0,System.Collections.Generic.IEqualityComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Reverse"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Reverse"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Reverse(System.Int32,System.Int32)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Reverse(System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.SetItem(System.Int32,`0)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.SetItem(System.Int32,`0)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Sort"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Sort"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Sort(System.Collections.Generic.IComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Sort(System.Collections.Generic.IComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Sort(System.Comparison{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Sort(System.Comparison{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.ToBuilder"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.ToBuilder"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList`1.TrueForAll(System.Predicate{`0})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableList`1.TrueForAll(System.Predicate{`0})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.Internal.SegmentedGenericArraySortHelper`1.SwapIfGreater(`0@,`0@)"> | |
| <summary>Swaps the values in the two references if the first is greater than the second.</summary> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.Internal.SegmentedGenericArraySortHelper`1.Swap(`0@,`0@)"> | |
| <summary>Swaps the values in the two references, regardless of whether the two references are the same.</summary> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.Internal.SegmentedArraySortUtils"> | |
| <summary>Helper methods for use in array/span sorting routines.</summary> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.Internal.HashHelpers.GetFastModMultiplier(System.UInt32)"> | |
| <summary>Returns approximate reciprocal of the divisor: ceil(2**64 / divisor).</summary> | |
| <remarks>This should only be used on 64-bit.</remarks> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.Internal.HashHelpers.FastMod(System.UInt32,System.UInt32,System.UInt64)"> | |
| <summary>Performs a mod operation using the multiplier pre-computed with <see cref="M:Microsoft.CodeAnalysis.Collections.Internal.HashHelpers.GetFastModMultiplier(System.UInt32)"/>.</summary> | |
| <remarks> | |
| PERF: This improves performance in 64-bit scenarios at the expense of performance in 32-bit scenarios. Since | |
| we only build a single AnyCPU binary, we opt for improved performance in the 64-bit scenario. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.Internal.ICollectionCalls"> | |
| <summary> | |
| Provides static methods to invoke <see cref="T:System.Collections.ICollection"/> members on value types that explicitly implement the | |
| member. | |
| </summary> | |
| <remarks> | |
| Normally, invocation of explicit interface members requires boxing or copying the value type, which is | |
| especially problematic for operations that mutate the value. Invocation through these helpers behaves like a | |
| normal call to an implicitly implemented member. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.Internal.ICollectionCalls`1"> | |
| <summary> | |
| Provides static methods to invoke <see cref="T:System.Collections.Generic.ICollection`1"/> members on value types that explicitly implement | |
| the member. | |
| </summary> | |
| <remarks> | |
| Normally, invocation of explicit interface members requires boxing or copying the value type, which is | |
| especially problematic for operations that mutate the value. Invocation through these helpers behaves like a | |
| normal call to an implicitly implemented member. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.Internal.IEnumerableCalls"> | |
| <summary> | |
| Provides static methods to invoke <see cref="T:System.Collections.IEnumerable"/> members on value types that explicitly implement the | |
| member. | |
| </summary> | |
| <remarks> | |
| Normally, invocation of explicit interface members requires boxing or copying the value type, which is | |
| especially problematic for operations that mutate the value. Invocation through these helpers behaves like a | |
| normal call to an implicitly implemented member. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.Internal.IEnumerableCalls`1"> | |
| <summary> | |
| Provides static methods to invoke <see cref="T:System.Collections.Generic.IEnumerable`1"/> members on value types that explicitly implement | |
| the member. | |
| </summary> | |
| <remarks> | |
| Normally, invocation of explicit interface members requires boxing or copying the value type, which is | |
| especially problematic for operations that mutate the value. Invocation through these helpers behaves like a | |
| normal call to an implicitly implemented member. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.Internal.IListCalls"> | |
| <summary> | |
| Provides static methods to invoke <see cref="T:System.Collections.IList"/> members on value types that explicitly implement the | |
| member. | |
| </summary> | |
| <remarks> | |
| Normally, invocation of explicit interface members requires boxing or copying the value type, which is | |
| especially problematic for operations that mutate the value. Invocation through these helpers behaves like a | |
| normal call to an implicitly implemented member. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.Internal.InsertionBehavior"> | |
| <summary> | |
| Used internally to control behavior of insertion into a <see cref="T:System.Collections.Generic.Dictionary`2"/> or <see cref="T:System.Collections.Generic.HashSet`1"/>. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.Internal.InsertionBehavior.None"> | |
| <summary> | |
| The default insertion behavior. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.Internal.InsertionBehavior.OverwriteExisting"> | |
| <summary> | |
| Specifies that an existing entry with the same key should be overwritten if encountered. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.Internal.InsertionBehavior.ThrowOnExisting"> | |
| <summary> | |
| Specifies that if an existing entry with the same key is encountered, an exception should be thrown. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.Internal.RoslynUnsafe.NullRef``1"> | |
| <summary> | |
| Returns a by-ref to type <typeparamref name="T"/> that is a null reference. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.Internal.RoslynUnsafe.IsNullRef``1(``0@)"> | |
| <summary> | |
| Returns if a given by-ref to type <typeparamref name="T"/> is a null reference. | |
| </summary> | |
| <remarks> | |
| This check is conceptually similar to <c>(void*)(&source) == nullptr</c>. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.Internal.SegmentedArrayHelper.FastPathMethodImplOptions"> | |
| <summary> | |
| A combination of <see cref="F:System.Runtime.CompilerServices.MethodImplOptions.AggressiveInlining"/> and | |
| <see cref="F:System.Runtime.CompilerServices.MethodImplOptions.AggressiveOptimization"/>. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.Internal.SegmentedArrayHelper.CalculateSegmentSize(System.Int32)"> | |
| <summary> | |
| Calculates the maximum number of elements of size <paramref name="elementSize"/> which can fit into an array | |
| which has the following characteristics: | |
| <list type="bullet"> | |
| <item><description>The array can be allocated in the small object heap.</description></item> | |
| <item><description>The array length is a power of 2.</description></item> | |
| </list> | |
| </summary> | |
| <param name="elementSize">The size of the elements in the array.</param> | |
| <returns>The segment size to use for small object heap segmented arrays.</returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.Internal.SegmentedArrayHelper.CalculateSegmentShift(System.Int32)"> | |
| <summary> | |
| Calculates a shift which can be applied to an absolute index to get the page index within a segmented array. | |
| </summary> | |
| <param name="segmentSize">The number of elements in each page of the segmented array. Must be a power of 2.</param> | |
| <returns>The shift to apply to the absolute index to get the page index within a segmented array.</returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.Internal.SegmentedArrayHelper.CalculateOffsetMask(System.Int32)"> | |
| <summary> | |
| Calculates a mask, which can be applied to an absolute index to get the index within a page of a segmented | |
| array. | |
| </summary> | |
| <param name="segmentSize">The number of elements in each page of the segmented array. Must be a power of 2.</param> | |
| <returns>The bit mask to obtain the index within a page from an absolute index within a segmented array.</returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.Update``1(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0}@,System.Func{Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0},Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0}})"> | |
| <summary> | |
| Mutates a value in-place with optimistic locking transaction semantics via a specified transformation | |
| function. The transformation is retried as many times as necessary to win the optimistic locking race. | |
| </summary> | |
| <typeparam name="T">The type of value stored by the list.</typeparam> | |
| <param name="location"> | |
| The variable or field to be changed, which may be accessed by multiple threads. | |
| </param> | |
| <param name="transformer"> | |
| A function that mutates the value. This function should be side-effect free, | |
| as it may run multiple times when races occur with other threads.</param> | |
| <returns> | |
| <see langword="true"/> if the location's value is changed by applying the result of the | |
| <paramref name="transformer"/> function; otherwise, <see langword="false"/> if the location's value remained | |
| the same because the last invocation of <paramref name="transformer"/> returned the existing value. | |
| </returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.Update``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0}@,System.Func{Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0},``1,Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0}},``1)"> | |
| <summary> | |
| Mutates a value in-place with optimistic locking transaction semantics via a specified transformation | |
| function. The transformation is retried as many times as necessary to win the optimistic locking race. | |
| </summary> | |
| <typeparam name="T">The type of value stored by the list.</typeparam> | |
| <typeparam name="TArg">The type of argument passed to the <paramref name="transformer"/>.</typeparam> | |
| <param name="location"> | |
| The variable or field to be changed, which may be accessed by multiple threads. | |
| </param> | |
| <param name="transformer"> | |
| A function that mutates the value. This function should be side-effect free, as it may run multiple times | |
| when races occur with other threads.</param> | |
| <param name="transformerArgument">The argument to pass to <paramref name="transformer"/>.</param> | |
| <returns> | |
| <see langword="true"/> if the location's value is changed by applying the result of the | |
| <paramref name="transformer"/> function; otherwise, <see langword="false"/> if the location's value remained | |
| the same because the last invocation of <paramref name="transformer"/> returned the existing value. | |
| </returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.InterlockedExchange``1(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0}@,Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0})"> | |
| <summary> | |
| Assigns a field or variable containing an immutable list to the specified value and returns the previous | |
| value. | |
| </summary> | |
| <typeparam name="T">The type of value stored by the list.</typeparam> | |
| <param name="location">The field or local variable to change.</param> | |
| <param name="value">The new value to assign.</param> | |
| <returns>The prior value at the specified <paramref name="location"/>.</returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.InterlockedCompareExchange``1(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0}@,Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0},Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0})"> | |
| <summary> | |
| Assigns a field or variable containing an immutable list to the specified value if it is currently equal to | |
| another specified value. Returns the previous value. | |
| </summary> | |
| <typeparam name="T">The type of value stored by the list.</typeparam> | |
| <param name="location">The field or local variable to change.</param> | |
| <param name="value">The new value to assign.</param> | |
| <param name="comparand">The value to check equality for before assigning.</param> | |
| <returns>The prior value at the specified <paramref name="location"/>.</returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.InterlockedInitialize``1(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0}@,Microsoft.CodeAnalysis.Collections.ImmutableSegmentedList{``0})"> | |
| <summary> | |
| Assigns a field or variable containing an immutable list to the specified value if it is has not yet been | |
| initialized. | |
| </summary> | |
| <typeparam name="T">The type of value stored by the list.</typeparam> | |
| <param name="location">The field or local variable to change.</param> | |
| <param name="value">The new value to assign.</param> | |
| <returns><see langword="true"/> if the field was assigned the specified value; otherwise, | |
| <see langword="false"/> if it was previously initialized.</returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.Update``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,System.Func{Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1},Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}})"> | |
| <summary> | |
| Mutates a value in-place with optimistic locking transaction semantics via a specified transformation | |
| function. The transformation is retried as many times as necessary to win the optimistic locking race. | |
| </summary> | |
| <typeparam name="TKey">The type of key stored by the dictionary.</typeparam> | |
| <typeparam name="TValue">The type of value stored by the dictionary.</typeparam> | |
| <param name="location"> | |
| The variable or field to be changed, which may be accessed by multiple threads. | |
| </param> | |
| <param name="transformer"> | |
| A function that mutates the value. This function should be side-effect free, | |
| as it may run multiple times when races occur with other threads.</param> | |
| <returns> | |
| <see langword="true"/> if the location's value is changed by applying the result of the | |
| <paramref name="transformer"/> function; otherwise, <see langword="false"/> if the location's value remained | |
| the same because the last invocation of <paramref name="transformer"/> returned the existing value. | |
| </returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.Update``3(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,System.Func{Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1},``2,Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}},``2)"> | |
| <summary> | |
| Mutates a value in-place with optimistic locking transaction semantics via a specified transformation | |
| function. The transformation is retried as many times as necessary to win the optimistic locking race. | |
| </summary> | |
| <typeparam name="TKey">The type of key stored by the dictionary.</typeparam> | |
| <typeparam name="TValue">The type of value stored by the dictionary.</typeparam> | |
| <typeparam name="TArg">The type of argument passed to the <paramref name="transformer"/>.</typeparam> | |
| <param name="location"> | |
| The variable or field to be changed, which may be accessed by multiple threads. | |
| </param> | |
| <param name="transformer"> | |
| A function that mutates the value. This function should be side-effect free, as it may run multiple times | |
| when races occur with other threads.</param> | |
| <param name="transformerArgument">The argument to pass to <paramref name="transformer"/>.</param> | |
| <returns> | |
| <see langword="true"/> if the location's value is changed by applying the result of the | |
| <paramref name="transformer"/> function; otherwise, <see langword="false"/> if the location's value remained | |
| the same because the last invocation of <paramref name="transformer"/> returned the existing value. | |
| </returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.InterlockedExchange``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1})"> | |
| <summary> | |
| Assigns a field or variable containing an immutable dictionary to the specified value and returns the | |
| previous value. | |
| </summary> | |
| <typeparam name="TKey">The type of key stored by the dictionary.</typeparam> | |
| <typeparam name="TValue">The type of value stored by the dictionary.</typeparam> | |
| <param name="location">The field or local variable to change.</param> | |
| <param name="value">The new value to assign.</param> | |
| <returns>The prior value at the specified <paramref name="location"/>.</returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.InterlockedCompareExchange``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1},Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1})"> | |
| <summary> | |
| Assigns a field or variable containing an immutable dictionary to the specified value if it is currently | |
| equal to another specified value. Returns the previous value. | |
| </summary> | |
| <typeparam name="TKey">The type of key stored by the dictionary.</typeparam> | |
| <typeparam name="TValue">The type of value stored by the dictionary.</typeparam> | |
| <param name="location">The field or local variable to change.</param> | |
| <param name="value">The new value to assign.</param> | |
| <param name="comparand">The value to check equality for before assigning.</param> | |
| <returns>The prior value at the specified <paramref name="location"/>.</returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.InterlockedInitialize``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1})"> | |
| <summary> | |
| Assigns a field or variable containing an immutable dictionary to the specified value if it is has not yet | |
| been initialized. | |
| </summary> | |
| <typeparam name="TKey">The type of key stored by the dictionary.</typeparam> | |
| <typeparam name="TValue">The type of value stored by the dictionary.</typeparam> | |
| <param name="location">The field or local variable to change.</param> | |
| <param name="value">The new value to assign.</param> | |
| <returns><see langword="true"/> if the field was assigned the specified value; otherwise, | |
| <see langword="false"/> if it was previously initialized.</returns> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.GetOrAdd``3(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,``0,System.Func{``0,``2,``1},``2)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableInterlocked.GetOrAdd``3(System.Collections.Immutable.ImmutableDictionary{``0,``1}@,``0,System.Func{``0,``2,``1},``2)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.GetOrAdd``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,``0,System.Func{``0,``1})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableInterlocked.GetOrAdd``2(System.Collections.Immutable.ImmutableDictionary{``0,``1}@,``0,System.Func{``0,``1})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.GetOrAdd``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,``0,``1)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableInterlocked.GetOrAdd``2(System.Collections.Immutable.ImmutableDictionary{``0,``1}@,``0,``1)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.AddOrUpdate``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,``0,System.Func{``0,``1},System.Func{``0,``1,``1})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableInterlocked.AddOrUpdate``2(System.Collections.Immutable.ImmutableDictionary{``0,``1}@,``0,System.Func{``0,``1},System.Func{``0,``1,``1})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.AddOrUpdate``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,``0,``1,System.Func{``0,``1,``1})"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableInterlocked.AddOrUpdate``2(System.Collections.Immutable.ImmutableDictionary{``0,``1}@,``0,``1,System.Func{``0,``1,``1})"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.TryAdd``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,``0,``1)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableInterlocked.TryAdd``2(System.Collections.Immutable.ImmutableDictionary{``0,``1}@,``0,``1)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.TryUpdate``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,``0,``1,``1)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableInterlocked.TryUpdate``2(System.Collections.Immutable.ImmutableDictionary{``0,``1}@,``0,``1,``1)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.RoslynImmutableInterlocked.TryRemove``2(Microsoft.CodeAnalysis.Collections.ImmutableSegmentedDictionary{``0,``1}@,``0,``1@)"> | |
| <inheritdoc cref="M:System.Collections.Immutable.ImmutableInterlocked.TryRemove``2(System.Collections.Immutable.ImmutableDictionary{``0,``1}@,``0,``1@)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.SegmentedArray.Clear``1(Microsoft.CodeAnalysis.Collections.SegmentedArray{``0},System.Int32,System.Int32)"> | |
| <seealso cref="M:System.Array.Clear(System.Array,System.Int32,System.Int32)"/> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.SegmentedArray.Copy``1(Microsoft.CodeAnalysis.Collections.SegmentedArray{``0},Microsoft.CodeAnalysis.Collections.SegmentedArray{``0},System.Int32)"> | |
| <seealso cref="M:System.Array.Copy(System.Array,System.Array,System.Int32)"/> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.SegmentedArray`1"> | |
| <summary> | |
| Defines a fixed-size collection with the same API surface and behavior as an "SZArray", which is a | |
| single-dimensional zero-based array commonly represented in C# as <c>T[]</c>. The implementation of this | |
| collection uses segmented arrays to avoid placing objects on the Large Object Heap. | |
| </summary> | |
| <typeparam name="T">The type of elements stored in the array.</typeparam> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SegmentedArray`1.SegmentSize"> | |
| <summary> | |
| The number of elements in each page of the segmented array of type <typeparamref name="T"/>. | |
| </summary> | |
| <remarks> | |
| <para>The segment size is calculated according to <see cref="M:System.Runtime.CompilerServices.Unsafe.SizeOf``1"/>, performs the IL operation | |
| defined by <see cref="F:System.Reflection.Emit.OpCodes.Sizeof"/>. ECMA-335 defines this operation with the following note:</para> | |
| <para><c>sizeof</c> returns the total size that would be occupied by each element in an array of this type – | |
| including any padding the implementation chooses to add. Specifically, array elements lie <c>sizeof</c> | |
| bytes apart.</para> | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SegmentedArray`1.SegmentShift"> | |
| <summary> | |
| The bit shift to apply to an array index to get the page index within <see cref="F:Microsoft.CodeAnalysis.Collections.SegmentedArray`1._items"/>. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SegmentedArray`1.OffsetMask"> | |
| <summary> | |
| The bit mask to apply to an array index to get the index within a page of <see cref="F:Microsoft.CodeAnalysis.Collections.SegmentedArray`1._items"/>. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2"> | |
| <summary> | |
| Represents a collection of keys and values. | |
| </summary> | |
| <remarks> | |
| <para>This collection has the same performance characteristics as <see cref="T:System.Collections.Generic.Dictionary`2"/>, but | |
| uses segmented arrays to avoid allocations in the Large Object Heap.</para> | |
| </remarks> | |
| <typeparam name="TKey">The type of the keys in the dictionary.</typeparam> | |
| <typeparam name="TValue">The type of the values in the dictionary.</typeparam> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2.EnsureCapacity(System.Int32)"> | |
| <summary> | |
| Ensures that the dictionary can hold up to 'capacity' entries without any further expansion of its backing storage | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2.TrimExcess"> | |
| <summary> | |
| Sets the capacity of this dictionary to what it would be if it had been originally initialized with all its entries | |
| </summary> | |
| <remarks> | |
| This method can be used to minimize the memory overhead | |
| once it is known that no new elements will be added. | |
| To allocate minimum size storage array, execute the following statements: | |
| dictionary.Clear(); | |
| dictionary.TrimExcess(); | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2.TrimExcess(System.Int32)"> | |
| <summary> | |
| Sets the capacity of this dictionary to hold up 'capacity' entries without any further expansion of its backing storage | |
| </summary> | |
| <remarks> | |
| This method can be used to minimize the memory overhead | |
| once it is known that no new elements will be added. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2.Entry._next"> | |
| <summary> | |
| 0-based index of next entry in chain: -1 means end of chain | |
| also encodes whether this entry _itself_ is part of the free list by changing sign and subtracting 3, | |
| so -2 means end of free list, -3 means index 0 but on free list, -4 means index 1 but on free list, etc. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.CodeAnalysis.Collections.SegmentedList`1"> | |
| <summary> | |
| Represents a strongly typed list of objects that can be accessed by index. Provides methods to search, sort, and | |
| manipulate lists. | |
| </summary> | |
| <remarks> | |
| <para>This collection has the same performance characteristics as <see cref="T:System.Collections.Generic.List`1"/>, but uses segmented | |
| arrays to avoid allocations in the Large Object Heap.</para> | |
| </remarks> | |
| <typeparam name="T">The type of elements in the list.</typeparam> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Arg_ArrayPlusOffTooSmall"> | |
| <summary>Destination array is not long enough to copy all the items in the collection. Check array index and length.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Arg_HTCapacityOverflow"> | |
| <summary>Hashtable's capacity overflowed and went negative. Check load factor, capacity and the current size of the table.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Arg_KeyNotFoundWithKey"> | |
| <summary>The given key '{0}' was not present in the dictionary.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Arg_LongerThanDestArray"> | |
| <summary>Destination array was not long enough. Check the destination index, length, and the array's lower bounds.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Arg_LongerThanSrcArray"> | |
| <summary>Source array was not long enough. Check the source index, length, and the array's lower bounds.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Arg_NonZeroLowerBound"> | |
| <summary>The lower bound of target array must be zero.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Arg_RankMultiDimNotSupported"> | |
| <summary>Only single dimensional arrays are supported for the requested action.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Arg_WrongType"> | |
| <summary>The value "{0}" is not of type "{1}" and cannot be used in this generic collection.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Argument_AddingDuplicateWithKey"> | |
| <summary>An item with the same key has already been added. Key: {0}</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Argument_InvalidArrayType"> | |
| <summary>Target array type is not compatible with the type of items in the collection.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Argument_InvalidOffLen"> | |
| <summary>Offset and length were out of bounds for the array or count is greater than the number of elements from index to the end of the source collection.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.ArgumentOutOfRange_ArrayLB"> | |
| <summary>Number was less than the array's lower bound in the first dimension.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.ArgumentOutOfRange_BiggerThanCollection"> | |
| <summary>Larger than collection size.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.ArgumentOutOfRange_Count"> | |
| <summary>Count must be positive and count must refer to a location within the string/array/collection.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.ArgumentOutOfRange_Index"> | |
| <summary>Index was out of range. Must be non-negative and less than the size of the collection.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.ArgumentOutOfRange_ListInsert"> | |
| <summary>Index must be within the bounds of the List.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.ArgumentOutOfRange_NeedNonNegNum"> | |
| <summary>Non-negative number required.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.ArgumentOutOfRange_SmallCapacity"> | |
| <summary>capacity was less than the current size.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.InvalidOperation_ConcurrentOperationsNotSupported"> | |
| <summary>Operations that change non-concurrent collections must have exclusive access. A concurrent update was performed on this collection and corrupted its state. The collection's state is no longer correct.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.InvalidOperation_EnumFailedVersion"> | |
| <summary>Collection was modified; enumeration operation may not execute.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.InvalidOperation_EnumOpCantHappen"> | |
| <summary>Enumeration has either not started or has already finished.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.InvalidOperation_IComparerFailed"> | |
| <summary>Failed to compare two elements in the array.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.NotSupported_KeyCollectionSet"> | |
| <summary>Mutating a key collection derived from a dictionary is not allowed.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.NotSupported_ValueCollectionSet"> | |
| <summary>Mutating a value collection derived from a dictionary is not allowed.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Rank_MustMatch"> | |
| <summary>The specified arrays must have the same number of dimensions.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.NotSupported_FixedSizeCollection"> | |
| <summary>Collection was of a fixed size.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.ArgumentException_OtherNotArrayOfCorrectLength"> | |
| <summary>Object is not a array with the same number of elements as the array to compare it to.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.Arg_BogusIComparer"> | |
| <summary>Unable to sort because the IComparer.Compare() method returns inconsistent results. Either a value does not compare equal to itself, or one value repeatedly compared to another value yields different results. IComparer: '{0}'.</summary> | |
| </member> | |
| <member name="P:Microsoft.CodeAnalysis.Collections.SR.CannotFindOldValue"> | |
| <summary>Cannot find the old value</summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildEngineResult"> | |
| <summary> | |
| This structure is used to return the result of the build and the target outputs. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEngineResult.buildResult"> | |
| <summary> | |
| Did the build pass or fail | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEngineResult.targetOutputsPerProject"> | |
| <summary> | |
| Target outputs by project | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEngineResult.#ctor(System.Boolean,System.Collections.Generic.List{System.Collections.Generic.IDictionary{System.String,Microsoft.Build.Framework.ITaskItem[]}})"> | |
| <summary> | |
| The constructor takes the result of the build and a list of the target outputs per project | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEngineResult.Result"> | |
| <summary> | |
| Did the build pass or fail. True means the build succeeded, False means the build failed. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEngineResult.TargetOutputsPerProject"> | |
| <summary> | |
| Outputs of the targets per project. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildEnvironmentState"> | |
| <summary> | |
| Class to encapsulate state that was stored in BuildEnvironmentHelper. | |
| </summary> | |
| <remarks> | |
| This should be deleted when BuildEnvironmentHelper can be moved into Framework. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildErrorEventArgs"> | |
| <summary> | |
| Arguments for error events | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.subcategory"> | |
| <summary> | |
| Subcategory of the error | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.code"> | |
| <summary> | |
| Error code | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.file"> | |
| <summary> | |
| File name | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.projectFile"> | |
| <summary> | |
| The project which issued the event | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.lineNumber"> | |
| <summary> | |
| Line number | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.columnNumber"> | |
| <summary> | |
| Column number | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.endLineNumber"> | |
| <summary> | |
| End line number | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.endColumnNumber"> | |
| <summary> | |
| End column number | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildErrorEventArgs.helpLink"> | |
| <summary> | |
| A link pointing to more information about the error | |
| </summary> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <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[])"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <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.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="helpLink">A link pointing to more information about the error </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildErrorEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.Subcategory"> | |
| <summary> | |
| The custom sub-type of the event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.Code"> | |
| <summary> | |
| Code associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.File"> | |
| <summary> | |
| File associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.ProjectFile"> | |
| <summary> | |
| The project file which issued this event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.LineNumber"> | |
| <summary> | |
| Line number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.ColumnNumber"> | |
| <summary> | |
| Column number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.EndLineNumber"> | |
| <summary> | |
| Ending line number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.EndColumnNumber"> | |
| <summary> | |
| Ending column number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildErrorEventArgs.HelpLink"> | |
| <summary> | |
| A link pointing to more information about the error. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildErrorEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildErrorEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes to a stream through a binary writer | |
| </summary> | |
| <param name="reader">Binary reader which the object will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildEventArgs"> | |
| <summary> | |
| This class encapsulates the default data associated with build events. | |
| It is intended to be extended/sub-classed. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventArgs.message"> | |
| <summary> | |
| Message. Volatile because it may be updated lock-free after construction. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventArgs.helpKeyword"> | |
| <summary> | |
| Help keyword | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventArgs.senderName"> | |
| <summary> | |
| Sender name | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventArgs.timestamp"> | |
| <summary> | |
| Timestamp | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventArgs.threadId"> | |
| <summary> | |
| Thread id | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventArgs.buildEventContext"> | |
| <summary> | |
| Build event context | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventArgs.#ctor(System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventArgs.#ctor(System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| This constructor allows all event data to be initialized while providing a custom timestamp. | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">TimeStamp of when the event was created</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventArgs.Timestamp"> | |
| <summary> | |
| The time when event was raised. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventArgs.RawTimestamp"> | |
| <summary> | |
| Exposes the private <see cref="F:Microsoft.Build.Framework.BuildEventArgs.timestamp"/> field to derived types. | |
| Used for serialization. Avoids the side effects of calling the | |
| <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Timestamp"/> getter. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventArgs.ThreadId"> | |
| <summary> | |
| The thread that raised event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventArgs.Message"> | |
| <summary> | |
| Text of event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventArgs.RawMessage"> | |
| <summary> | |
| Exposes the underlying message field without side-effects. | |
| Used for serialization. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventArgs.FormattedMessage"> | |
| <summary> | |
| Like <see cref="P:Microsoft.Build.Framework.BuildEventArgs.RawMessage"/> but returns a formatted message string if available. | |
| Used for serialization. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword"> | |
| <summary> | |
| Custom help keyword associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventArgs.SenderName"> | |
| <summary> | |
| Name of the object sending this event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventArgs.BuildEventContext"> | |
| <summary> | |
| Event contextual information for the build event argument | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventArgs.WriteToStreamWithExplicitMessage(System.IO.BinaryWriter,System.String)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| <param name="messageToWrite">The message to write to the stream.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventArgs.SetBuildEventContextDefaultBeforeSerialization(System.Runtime.Serialization.StreamingContext)"> | |
| <summary> | |
| Run before the object has been deserialized | |
| UNDONE (Logging.) Can this and the next function go away, and instead return a BuildEventContext.Invalid from | |
| the property if the buildEventContext field is null? | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventArgs.SetBuildEventContextDefaultAfterSerialization(System.Runtime.Serialization.StreamingContext)"> | |
| <summary> | |
| Run after the object has been deserialized | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventArgs.ResourceStringFormatter"> | |
| <summary> | |
| This is the default stub implementation, only here as a safeguard. | |
| Actual logic is injected from Microsoft.Build.dll to replace this. | |
| This is used by the Message property overrides to reconstruct the | |
| message lazily on demand. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventArgs.FormatResourceStringIgnoreCodeAndKeyword(System.String,System.String[])"> | |
| <summary> | |
| Shortcut method to mimic the original logic of creating the formatted strings. | |
| </summary> | |
| <param name="resourceName">Name of the resource string.</param> | |
| <param name="arguments">Optional list of arguments to pass to the formatted string.</param> | |
| <returns>The concatenated formatted string.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildEventContext"> | |
| <summary> | |
| Will provide location information for an event, this is especially | |
| needed in a multi processor environment | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext._nodeId"> | |
| <summary> | |
| Node event was in | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext._targetId"> | |
| <summary> | |
| Target event was in | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext._projectContextId"> | |
| <summary> | |
| The node-unique project request context the event was in | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext._taskId"> | |
| <summary> | |
| Id of the task the event was caused from | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext._projectInstanceId"> | |
| <summary> | |
| The id of the project instance to which this event refers. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext._submissionId"> | |
| <summary> | |
| The id of the submission. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext._evaluationId"> | |
| <summary> | |
| The id of the evaluation | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)"> | |
| <summary> | |
| This is the original constructor. No one should ever use this except internally for backward compatibility. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> | |
| <summary> | |
| Constructs a BuildEventContext with a specified project instance id. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> | |
| <summary> | |
| Constructs a BuildEventContext with a specific submission id | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> | |
| <summary> | |
| Constructs a BuildEventContext | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventContext.Invalid"> | |
| <summary> | |
| Returns a default invalid BuildEventContext | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventContext.EvaluationId"> | |
| <summary> | |
| Retrieves the Evaluation id. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventContext.NodeId"> | |
| <summary> | |
| NodeId where event took place | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventContext.TargetId"> | |
| <summary> | |
| Id of the target the event was in when the event was fired | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventContext.ProjectContextId"> | |
| <summary> | |
| Retrieves the Project Context id. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventContext.TaskId"> | |
| <summary> | |
| Retrieves the task id. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventContext.ProjectInstanceId"> | |
| <summary> | |
| Retrieves the project instance id. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventContext.SubmissionId"> | |
| <summary> | |
| Retrieves the Submission id. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildEventContext.BuildRequestId"> | |
| <summary> | |
| Retrieves the BuildRequest id. Note that this is not the same as the global request id on a BuildRequest or BuildResult. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidProjectContextId"> | |
| <summary> | |
| Indicates an invalid project context identifier. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidTaskId"> | |
| <summary> | |
| Indicates an invalid task identifier. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidTargetId"> | |
| <summary> | |
| Indicates an invalid target identifier. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidNodeId"> | |
| <summary> | |
| Indicates an invalid node identifier. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidProjectInstanceId"> | |
| <summary> | |
| Indicates an invalid project instance identifier. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidSubmissionId"> | |
| <summary> | |
| Indicates an invalid submission identifier. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildEventContext.InvalidEvaluationId"> | |
| <summary> | |
| Indicates an invalid evaluation identifier. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventContext.GetHashCode"> | |
| <summary> | |
| Retrieves a hash code for this BuildEventContext. | |
| </summary> | |
| <returns></returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventContext.Equals(System.Object)"> | |
| <summary> | |
| Compare a BuildEventContext with this BuildEventContext. | |
| A build event context is compared in the following way. | |
| 1. If the object references are the same the contexts are equivalent | |
| 2. If the object type is the same and the Id values in the context are the same, the contexts are equivalent | |
| </summary> | |
| <param name="obj"></param> | |
| <returns></returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventContext.op_Equality(Microsoft.Build.Framework.BuildEventContext,Microsoft.Build.Framework.BuildEventContext)"> | |
| <summary> | |
| Override == so the equals comparison using this operator will be the same as | |
| .Equals | |
| </summary> | |
| <param name="left">Left hand side operand</param> | |
| <param name="right">Right hand side operand</param> | |
| <returns>True if the object values are identical, false if they are not identical</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventContext.op_Inequality(Microsoft.Build.Framework.BuildEventContext,Microsoft.Build.Framework.BuildEventContext)"> | |
| <summary> | |
| Override != so the equals comparison using this operator will be the same as | |
| ! Equals | |
| </summary> | |
| <param name="left">Left hand side operand</param> | |
| <param name="right">Right hand side operand</param> | |
| <returns>True if the object values are not identical, false if they are identical</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildEventContext.InternalEquals(Microsoft.Build.Framework.BuildEventContext)"> | |
| <summary> | |
| Verify the fields are identical | |
| </summary> | |
| <param name="buildEventContext">BuildEventContext to compare to this instance</param> | |
| <returns>True if the value fields are the same, false if otherwise</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildException.BuildExceptionBase.InitializeCustomState(System.Collections.Generic.IDictionary{System.String,System.String})"> | |
| <summary> | |
| Override this method to recover subtype-specific state from the remote exception. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildException.BuildExceptionBase.FlushCustomState"> | |
| <summary> | |
| Override this method to provide subtype-specific state to be serialized. | |
| </summary> | |
| <returns></returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildException.BuildExceptionRemoteState"> | |
| <summary> | |
| Remote exception internal data serving as the source for the exception deserialization. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildException.GenericBuildTransferredException"> | |
| <summary> | |
| A catch-all type for remote exceptions that we don't know how to deserialize. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildFinishedEventArgs"> | |
| <summary> | |
| This class represents the event arguments for build finished events. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.BuildFinishedEventArgs.succeeded"> | |
| <summary> | |
| Whether the build succeeded | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.#ctor(System.String,System.String,System.Boolean)"> | |
| <summary> | |
| Constructor to initialize all parameters. | |
| Sender field cannot be set here and is assumed to be "MSBuild" | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="succeeded">True indicates a successful build</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.#ctor(System.String,System.String,System.Boolean,System.DateTime)"> | |
| <summary> | |
| Constructor which allows the timestamp to be set | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="succeeded">True indicates a successful build</param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.#ctor(System.String,System.String,System.Boolean,System.DateTime,System.Object[])"> | |
| <summary> | |
| Constructor which allows the timestamp to be set | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="succeeded">True indicates a successful build</param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildFinishedEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildFinishedEventArgs.Succeeded"> | |
| <summary> | |
| Succeeded is true if the build succeeded; false otherwise. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.MessageImportance"> | |
| <summary> | |
| This enumeration provides three levels of importance for messages. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.MessageImportance.High"> | |
| <summary> | |
| High importance, appears in less verbose logs | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.MessageImportance.Normal"> | |
| <summary> | |
| Normal importance | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.MessageImportance.Low"> | |
| <summary> | |
| Low importance, appears in more verbose logs | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildMessageEventArgs"> | |
| <summary> | |
| Arguments for message events | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor(System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor(System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime)"> | |
| <summary> | |
| This constructor allows a timestamp to be set | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.#ctor(System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor allows a timestamp to be set | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| <param name="eventTimestamp">custom timestamp for the event</param> | |
| </member> | |
| <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[])"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| <param name="eventTimestamp">custom timestamp for the event</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildMessageEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.Importance"> | |
| <summary> | |
| Importance of the message | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.Subcategory"> | |
| <summary> | |
| The custom sub-type of the event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.Code"> | |
| <summary> | |
| Code associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.File"> | |
| <summary> | |
| File associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.LineNumber"> | |
| <summary> | |
| Line number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.ColumnNumber"> | |
| <summary> | |
| Column number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.EndLineNumber"> | |
| <summary> | |
| Ending line number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.EndColumnNumber"> | |
| <summary> | |
| Ending column number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildMessageEventArgs.ProjectFile"> | |
| <summary> | |
| The project which was building when the message was issued. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildStartedEventArgs"> | |
| <summary> | |
| Arguments for build started events. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor(System.String,System.String)"> | |
| <summary> | |
| Constructor to initialize all parameters. | |
| Sender field cannot be set here and is assumed to be "MSBuild" | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String})"> | |
| <summary> | |
| Constructor to initialize all parameters. | |
| Sender field cannot be set here and is assumed to be "MSBuild" | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="environmentOfBuild">A dictionary which lists the environment of the build when the build is started.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor(System.String,System.String,System.DateTime)"> | |
| <summary> | |
| Constructor to allow timestamp to be set | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildStartedEventArgs.#ctor(System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| Constructor to allow timestamp to be set | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| <param name="messageArgs">message args</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildStartedEventArgs.BuildEnvironment"> | |
| <summary> | |
| The environment which is used at the start of the build | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildStatusEventArgs"> | |
| <summary> | |
| Base class for build status events. This class is meant | |
| to be extended. | |
| </summary> | |
| <remarks> | |
| WARNING: marking a type [Serializable] without implementing | |
| ISerializable imposes a serialization contract -- it is a | |
| promise to never change the type's fields i.e. the type is | |
| immutable; adding new fields in the next version of the type | |
| without following certain special FX guidelines, can break both | |
| forward and backward compatibility | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildStatusEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildStatusEventArgs.#ctor(System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildStatusEventArgs.#ctor(System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildStatusEventArgs.#ctor(System.String,System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">Optional arguments for formatting the message string.</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildWarningEventArgs"> | |
| <summary> | |
| Arguments for warning events | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildWarningEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">custom timestamp for the event</param> | |
| </member> | |
| <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[])"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">custom timestamp for the event</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <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.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="helpLink">A link pointing to more information about the warning</param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">custom timestamp for the event</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildWarningEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes the Errorevent to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.BuildWarningEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.Subcategory"> | |
| <summary> | |
| The custom sub-type of the event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.Code"> | |
| <summary> | |
| Code associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.File"> | |
| <summary> | |
| File associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.LineNumber"> | |
| <summary> | |
| Line number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.ColumnNumber"> | |
| <summary> | |
| Column number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.EndLineNumber"> | |
| <summary> | |
| Ending line number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.EndColumnNumber"> | |
| <summary> | |
| Ending column number of interest in associated file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.ProjectFile"> | |
| <summary> | |
| The project which was building when the message was issued. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.BuildWarningEventArgs.HelpLink"> | |
| <summary> | |
| A link pointing to more information about the warning. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ChangeWaves"> | |
| <summary> | |
| Coupled together with the MSBUILDDISABLEFEATURESFROMVERSION environment variable, | |
| this class acts as a way to make risky changes while giving customers an opt-out. | |
| </summary> | |
| See docs here: https://github.com/dotnet/msbuild/blob/main/documentation/wiki/ChangeWaves.md | |
| For dev docs: https://github.com/dotnet/msbuild/blob/main/documentation/wiki/ChangeWaves-Dev.md | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ChangeWaves.EnableAllFeatures"> | |
| <summary> | |
| Special value indicating that all features behind all Change Waves should be enabled. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ChangeWaves.LowestWave"> | |
| <summary> | |
| The lowest wave in the current rotation of Change Waves. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ChangeWaves.HighestWave"> | |
| <summary> | |
| The highest wave in the current rotation of Change Waves. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ChangeWaves.ShouldApplyChangeWave"> | |
| <summary> | |
| Checks the conditions for whether or not we want ApplyChangeWave to be called again. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ChangeWaves.DisabledWave"> | |
| <summary> | |
| The current disabled wave. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ChangeWaves.ConversionState"> | |
| <summary> | |
| The status of how the disabled wave was set. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ChangeWaves.ApplyChangeWave"> | |
| <summary> | |
| Read from environment variable `MSBUILDDISABLEFEATURESFROMVERSION`, correct it if required, cache it and its ConversionState. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ChangeWaves.AreFeaturesEnabled(System.Version)"> | |
| <summary> | |
| Determines whether features behind the given wave are enabled. | |
| </summary> | |
| <param name="wave">The version to compare.</param> | |
| <returns>A bool indicating whether the change wave is enabled.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ChangeWaves.ResetStateForTests"> | |
| <summary> | |
| Resets the state and value of the currently disabled version. | |
| Used for testing only. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.CriticalBuildMessageEventArgs"> | |
| <summary> | |
| Arguments for critical message events. These always have High importance. | |
| </summary> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">custom timestamp for the event</param> | |
| </member> | |
| <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[])"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">custom timestamp for the event</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.CriticalBuildMessageEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.CustomBuildEventArgs"> | |
| <summary> | |
| Arguments for custom build events. | |
| </summary> | |
| <remarks> | |
| <format type="text/markdown"><![CDATA[ | |
| ## Remarks | |
| > [!CAUTION] | |
| In .NET 8 and later and Visual Studio 17.8 and later, this type is deprecated; instead use <see cref="ExtendedCustomBuildEventArgs"/>. | |
| For more information, see <see href="https://learn.microsoft.com/dotnet/core/compatibility/sdk/8.0/custombuildeventargs"/> | |
| For recommended replacement, see <see href="https://learn.microsoft.com/dotnet/core/compatibility/sdk/8.0/custombuildeventargs#recommended-action" />. | |
| ]]></format> | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.CustomBuildEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.CustomBuildEventArgs.#ctor(System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of sender</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.CustomBuildEventArgs.#ctor(System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| This constructor allows event data to be initialized including timestamp. | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.CustomBuildEventArgs.#ctor(System.String,System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor allows event data to be initialized including timestamp. | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">Message arguments</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.EngineServices"> | |
| <summary> | |
| Exposes build engine functionality that was made available in newer versions of MSBuild. | |
| </summary> | |
| <remarks> | |
| Make all members virtual but not abstract, ensuring that implementations can override them and external implementations | |
| won't break when the class is extended with new members. This base implementation should be throwing <see cref="T:System.NotImplementedException"/>. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EngineServices.Version1"> | |
| <summary> | |
| Initial version with LogsMessagesOfImportance() and IsTaskInputLoggingEnabled as the only exposed members. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.EngineServices.Version"> | |
| <summary> | |
| Gets an explicit version of this class. | |
| </summary> | |
| <remarks> | |
| Must be incremented whenever new members are added. Derived classes should override | |
| the property to return the version actually being implemented. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EngineServices.LogsMessagesOfImportance(Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| Returns <see langword="true"/> if the given message importance is not guaranteed to be ignored by registered loggers. | |
| </summary> | |
| <param name="importance">The importance to check.</param> | |
| <returns>True if messages of the given importance should be logged, false if it's guaranteed that such messages would be ignored.</returns> | |
| <remarks> | |
| Example: If we know that no logger is interested in <see cref="F:Microsoft.Build.Framework.MessageImportance.Low"/>, this method returns <see langword="true"/> | |
| for <see cref="F:Microsoft.Build.Framework.MessageImportance.Normal"/> and <see cref="F:Microsoft.Build.Framework.MessageImportance.High"/>, and returns <see langword="false"/> | |
| for <see cref="F:Microsoft.Build.Framework.MessageImportance.Low"/>. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.EngineServices.IsTaskInputLoggingEnabled"> | |
| <summary> | |
| Returns <see langword="true"/> if the build is configured to log all task inputs. | |
| </summary> | |
| <remarks> | |
| This is a performance optimization allowing tasks to skip expensive double-logging. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.EnvironmentVariableReadEventArgs"> | |
| <summary> | |
| Arguments for the environment variable read event. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EnvironmentVariableReadEventArgs.#ctor"> | |
| <summary> | |
| Initializes an instance of the EnvironmentVariableReadEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EnvironmentVariableReadEventArgs.#ctor(System.String,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| Initializes an instance of the EnvironmentVariableReadEventArgs class. | |
| </summary> | |
| <param name="environmentVariableName">The name of the environment variable that was read.</param> | |
| <param name="message">The value of the environment variable that was read.</param> | |
| <param name="helpKeyword">Help keyword.</param> | |
| <param name="senderName">The name of the sender of the event.</param> | |
| <param name="importance">The importance of the message.</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.EnvironmentVariableReadEventArgs.EnvironmentVariableName"> | |
| <summary> | |
| The name of the environment variable that was read. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.FrameworkErrorUtilities.VerifyThrow(System.Boolean,System.String)"> | |
| <summary> | |
| This method should be used in places where one would normally put | |
| an "assert". It should be used to validate that our assumptions are | |
| true, where false would indicate that there must be a bug in our | |
| code somewhere. This should not be used to throw errors based on bad | |
| user input or anything that the user did wrong. | |
| </summary> | |
| <param name="condition"></param> | |
| <param name="unformattedMessage"></param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.FrameworkErrorUtilities.VerifyThrowInternalNull(System.Object,System.String)"> | |
| <summary> | |
| Helper to throw an InternalErrorException when the specified parameter is null. | |
| This should be used ONLY if this would indicate a bug in MSBuild rather than | |
| anything caused by user action. | |
| </summary> | |
| <param name="parameter">The value of the argument.</param> | |
| <param name="parameterName">Parameter that should not be null.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.FrameworkErrorUtilities.ThrowInternalError(System.String,System.Exception,System.Object[])"> | |
| <summary> | |
| Throws InternalErrorException. | |
| This is only for situations that would mean that there is a bug in MSBuild itself. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs"> | |
| <summary> | |
| Generic custom error events including extended data for event enriching. | |
| Extended data are implemented by <see cref="T:Microsoft.Build.Framework.IExtendedBuildEventArgs"/> | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs.ExtendedType"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs.ExtendedMetadata"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs.ExtendedData"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs.#ctor"> | |
| <summary> | |
| Default constructor. Used for deserialization. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs.#ctor(System.String)"> | |
| <summary> | |
| This constructor specifies only type of extended data. | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildErrorEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="helpLink">A link pointing to more information about the error </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs"> | |
| <summary> | |
| Generic custom build events including extended data for event enriching. | |
| Extended data are implemented by <see cref="T:Microsoft.Build.Framework.IExtendedBuildEventArgs"/> | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.ExtendedType"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.ExtendedMetadata"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.ExtendedData"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.#ctor"> | |
| <summary> | |
| Default constructor. Used for deserialization. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.#ctor(System.String)"> | |
| <summary> | |
| This constructor specifies only type of extended data. | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime)"> | |
| <summary> | |
| This constructor allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.#ctor(System.String,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)"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildMessageEventArgs.#ctor(System.String,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[])"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="importance">importance of the message</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs"> | |
| <summary> | |
| Generic custom warning events including extended data for event enriching. | |
| Extended data are implemented by <see cref="T:Microsoft.Build.Framework.IExtendedBuildEventArgs"/> | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs.ExtendedType"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs.ExtendedMetadata"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs.ExtendedData"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs.#ctor"> | |
| <summary> | |
| Default constructor. Used for deserialization. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs.#ctor(System.String)"> | |
| <summary> | |
| This constructor specifies only type of extended data. | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedBuildWarningEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor which allows a timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event sub-category</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="helpLink">A link pointing to more information about the error </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ExtendedCriticalBuildMessageEventArgs"> | |
| <summary> | |
| Critical message events arguments including extended data for event enriching. | |
| Extended data are implemented by <see cref="T:Microsoft.Build.Framework.IExtendedBuildEventArgs"/> | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedCriticalBuildMessageEventArgs.ExtendedType"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedCriticalBuildMessageEventArgs.ExtendedMetadata"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedCriticalBuildMessageEventArgs.ExtendedData"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCriticalBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows all event data to be initialized | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCriticalBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">custom timestamp for the event</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCriticalBuildMessageEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor allows timestamp to be set | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="subcategory">event subcategory</param> | |
| <param name="code">event code</param> | |
| <param name="file">file associated with the event</param> | |
| <param name="lineNumber">line number (0 if not applicable)</param> | |
| <param name="columnNumber">column number (0 if not applicable)</param> | |
| <param name="endLineNumber">end line number (0 if not applicable)</param> | |
| <param name="endColumnNumber">end column number (0 if not applicable)</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of event sender</param> | |
| <param name="eventTimestamp">custom timestamp for the event</param> | |
| <param name="messageArgs">message arguments</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCriticalBuildMessageEventArgs.#ctor"> | |
| <summary> | |
| Default constructor. Used for deserialization. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCriticalBuildMessageEventArgs.#ctor(System.String)"> | |
| <summary> | |
| This constructor specifies only type of extended data. | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ExtendedCustomBuildEventArgs"> | |
| <summary> | |
| Generic custom event. | |
| Extended data are implemented by <see cref="T:Microsoft.Build.Framework.IExtendedBuildEventArgs"/> | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedCustomBuildEventArgs.ExtendedType"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedCustomBuildEventArgs.ExtendedMetadata"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExtendedCustomBuildEventArgs.ExtendedData"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCustomBuildEventArgs.#ctor"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| </summary> | |
| <seealso cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCustomBuildEventArgs.#ctor(System.String)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <seealso cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCustomBuildEventArgs.#ctor(System.String,System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of sender</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCustomBuildEventArgs.#ctor(System.String,System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| This constructor allows event data to be initialized including timestamp. | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExtendedCustomBuildEventArgs.#ctor(System.String,System.String,System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor allows event data to be initialized including timestamp. | |
| </summary> | |
| <param name="type">Type of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"/>.</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="senderName">name of sender</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| <param name="messageArgs">Message arguments</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs"> | |
| <summary> | |
| Arguments for external project finished events | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Boolean)"> | |
| <summary> | |
| Useful constructor | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword</param> | |
| <param name="senderName">name of the object sending this event</param> | |
| <param name="projectFile">project name</param> | |
| <param name="succeeded">true indicates project built successfully</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Boolean,System.DateTime)"> | |
| <summary> | |
| Useful constructor including the ability to set the timestamp | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword</param> | |
| <param name="senderName">name of the object sending this event</param> | |
| <param name="projectFile">project name</param> | |
| <param name="succeeded">true indicates project built successfully</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.ProjectFile"> | |
| <summary> | |
| Project name | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs.Succeeded"> | |
| <summary> | |
| True if project built successfully, false otherwise | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ExternalProjectStartedEventArgs"> | |
| <summary> | |
| Arguments for external project started events | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String)"> | |
| <summary> | |
| Useful constructor | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword</param> | |
| <param name="senderName">name of the object sending this event</param> | |
| <param name="projectFile">project name</param> | |
| <param name="targetNames">targets we are going to build (empty indicates default targets)</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| Useful constructor, including the ability to set the timestamp of the event | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword</param> | |
| <param name="senderName">name of the object sending this event</param> | |
| <param name="projectFile">project name</param> | |
| <param name="targetNames">targets we are going to build (empty indicates default targets)</param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.ProjectFile"> | |
| <summary> | |
| Project name | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.TargetNames"> | |
| <summary> | |
| Targets that we will build in the project. This may mean different things for different project types, | |
| our tasks will put something like Rebuild, Clean, etc. here. This may be null if the project is being | |
| built with the default target. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.FeatureStatus"> | |
| <summary> | |
| The status of a feature. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.FeatureStatus.Undefined"> | |
| <summary> | |
| The feature availability is not determined. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.FeatureStatus.Available"> | |
| <summary> | |
| The feature is available. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.FeatureStatus.NotAvailable"> | |
| <summary> | |
| The feature is not available. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.FeatureStatus.Preview"> | |
| <summary> | |
| The feature is in preview, subject to change API or behavior between releases. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Features"> | |
| <summary> | |
| This class is used to manage features. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Features.CheckFeatureAvailability(System.String)"> | |
| <summary> | |
| Checks if a feature is available or not. | |
| </summary> | |
| <param name="featureName">The name of the feature.</param> | |
| <returns>A feature status <see cref="T:Microsoft.Build.Framework.FeatureStatus"/>.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.FileClassifier"> | |
| <summary> | |
| Attempts to classify project files for various purposes such as safety and performance. | |
| </summary> | |
| <remarks> | |
| Callers of this class are responsible to respect current OS path string comparison. | |
| <para> | |
| The term "project files" refers to the root project file (e.g. <c>MyProject.csproj</c>) and | |
| any other <c>.props</c> and <c>.targets</c> files it imports. | |
| </para> | |
| <para> | |
| Classifications provided are: | |
| <list type="number"> | |
| <item> | |
| <see cref="M:Microsoft.Build.Framework.FileClassifier.IsNonModifiable(System.String)" /> which indicates the file is not expected to change over time, | |
| other than when it is first created. This is a subset of non-user-editable files and | |
| generally excludes generated files which can be regenerated in response to user actions. | |
| </item> | |
| </list> | |
| </para> | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.FileClassifier.PathComparison"> | |
| <summary> | |
| StringComparison used for comparing paths on current OS. | |
| </summary> | |
| <remarks> | |
| TODO: Replace RuntimeInformation.IsOSPlatform(OSPlatform.Linux) by NativeMethodsShared.OSUsesCaseSensitivePaths once it is moved out from Shared | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.FileClassifier.s_sharedInstance"> | |
| <summary> | |
| Single, static <see cref="T:System.Lazy`1"/> instance of shared file FileClassifier for <see cref="P:Microsoft.Build.Framework.FileClassifier.Shared"/> member. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.FileClassifier._knownImmutableDirectories"> | |
| <summary> | |
| Serves purpose of thread safe set of known immutable directories. | |
| </summary> | |
| <remarks> | |
| Although <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2"></see> is not optimal memory-wise, in this particular case it does not matter | |
| much as the expected size of this set is ~5 and in very extreme cases less then 100. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.FileClassifier._knownImmutableDirectoriesSnapshot"> | |
| <summary> | |
| Copy on write snapshot of <see cref="F:Microsoft.Build.Framework.FileClassifier._knownImmutableDirectories"/>. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.FileClassifier.#ctor"> | |
| <summary> | |
| Creates default FileClassifier which following immutable folders: | |
| Classifications provided are: | |
| <list type="number"> | |
| <item>Program Files\Reference Assemblies\Microsoft</item> | |
| <item>Program Files (x86)\Reference Assemblies\Microsoft</item> | |
| <item>Visual Studio installation root</item> | |
| </list> | |
| </summary> | |
| <remarks> | |
| Individual projects NuGet folders are added during project build by calling | |
| <see cref="M:Microsoft.Build.Framework.FileClassifier.RegisterImmutableDirectory(System.String)" /> | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.FileClassifier.Shared"> | |
| <summary> | |
| Shared singleton instance. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.FileClassifier.RegisterImmutableDirectory(System.String)"> | |
| <summary> | |
| Try add path into set of known immutable paths. | |
| Files under any of these folders are considered non-modifiable. | |
| </summary> | |
| <remarks> | |
| This value is used by <see cref="M:Microsoft.Build.Framework.FileClassifier.IsNonModifiable(System.String)" />. | |
| Files in the NuGet package cache are not expected to change over time, once they are created. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.FileClassifier.IsNonModifiable(System.String)"> | |
| <summary> | |
| Gets whether a file is expected to not be modified in place on disk once it has been created. | |
| </summary> | |
| <param name="filePath">The path to the file to test.</param> | |
| <returns><see langword="true" /> if the file is non-modifiable, otherwise <see langword="false" />.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.GeneratedFileUsedEventArgs"> | |
| <summary> | |
| Arguments for the generated file used event | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.GeneratedFileUsedEventArgs.#ctor(System.String,System.String)"> | |
| <summary> | |
| Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.GeneratedFileUsedEventArgs"/> class. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.GeneratedFileUsedEventArgs.FilePath"> | |
| <summary> | |
| The file path relative to the current project. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.GeneratedFileUsedEventArgs.Content"> | |
| <summary> | |
| The content of the file. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine"> | |
| <summary> | |
| This interface exposes functionality on the build engine | |
| that is required for task authoring. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine.LogErrorEvent(Microsoft.Build.Framework.BuildErrorEventArgs)"> | |
| <summary> | |
| Allows tasks to raise error events to all registered loggers. | |
| The build engine may perform some filtering or | |
| pre-processing on the events, before dispatching them. | |
| </summary> | |
| <param name="e">Details of event to raise.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine.LogWarningEvent(Microsoft.Build.Framework.BuildWarningEventArgs)"> | |
| <summary> | |
| Allows tasks to raise warning events to all registered loggers. | |
| The build engine may perform some filtering or | |
| pre-processing on the events, before dispatching them. | |
| </summary> | |
| <param name="e">Details of event to raise.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine.LogMessageEvent(Microsoft.Build.Framework.BuildMessageEventArgs)"> | |
| <summary> | |
| Allows tasks to raise message events to all registered loggers. | |
| The build engine may perform some filtering or | |
| pre-processing on the events, before dispatching them. | |
| </summary> | |
| <param name="e">Details of event to raise.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine.LogCustomEvent(Microsoft.Build.Framework.CustomBuildEventArgs)"> | |
| <summary> | |
| Allows tasks to raise custom events to all registered loggers. | |
| The build engine may perform some filtering or | |
| pre-processing on the events, before dispatching them. | |
| </summary> | |
| <param name="e">Details of event to raise.</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IBuildEngine.ContinueOnError"> | |
| <summary> | |
| Returns true if the ContinueOnError flag was set to true for this particular task | |
| in the project file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IBuildEngine.LineNumberOfTaskNode"> | |
| <summary> | |
| Retrieves the line number of the task node within the project file that called it. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IBuildEngine.ColumnNumberOfTaskNode"> | |
| <summary> | |
| Retrieves the line number of the task node within the project file that called it. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IBuildEngine.ProjectFileOfTaskNode"> | |
| <summary> | |
| Returns the full path to the project file that contained the call to this task. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine.BuildProjectFile(System.String,System.String[],System.Collections.IDictionary,System.Collections.IDictionary)"> | |
| <summary> | |
| This method allows tasks to initiate a build on a | |
| particular project file. If the build is successful, the outputs | |
| (if any) of the specified targets are returned. | |
| </summary> | |
| <remarks> | |
| 1) it is acceptable to pass null for both <c>targetNames</c> and <c>targetOutputs</c> | |
| 2) if no targets are specified, the default targets are built | |
| 3) target outputs are returned as <c>ITaskItem</c> arrays indexed by target name | |
| </remarks> | |
| <param name="projectFileName">The project to build.</param> | |
| <param name="targetNames">The targets in the project to build (can be null).</param> | |
| <param name="globalProperties">A hash table of additional global properties to apply | |
| to the child project (can be null). The key and value should both be strings.</param> | |
| <param name="targetOutputs">The outputs of each specified target (can be null).</param> | |
| <returns>true, if build was successful</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine10"> | |
| <summary> | |
| This interface extends <see cref="T:Microsoft.Build.Framework.IBuildEngine9" /> to provide a reference to the <see cref="P:Microsoft.Build.Framework.IBuildEngine10.EngineServices" /> class. | |
| Future engine API should be added to the class as opposed to introducing yet another version of the IBuildEngine interface. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IBuildEngine10.EngineServices"> | |
| <summary> | |
| Returns the new build engine interface. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine2"> | |
| <summary> | |
| This interface extends IBuildEngine to provide a method allowing building | |
| project files in parallel. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IBuildEngine2.IsRunningMultipleNodes"> | |
| <summary> | |
| This property allows a task to query whether or not the system is running in single process mode or multi process mode. | |
| 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. | |
| 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. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine2.BuildProjectFile(System.String,System.String[],System.Collections.IDictionary,System.Collections.IDictionary,System.String)"> | |
| <summary> | |
| This method allows tasks to initiate a build on a | |
| particular project file. If the build is successful, the outputs | |
| (if any) of the specified targets are returned. | |
| </summary> | |
| <remarks> | |
| 1) it is acceptable to pass null for both <c>targetNames</c> and <c>targetOutputs</c> | |
| 2) if no targets are specified, the default targets are built | |
| 3) target outputs are returned as <c>ITaskItem</c> arrays indexed by target name | |
| </remarks> | |
| <param name="projectFileName">The project to build.</param> | |
| <param name="targetNames">The targets in the project to build (can be null).</param> | |
| <param name="globalProperties">A hash table of additional global properties to apply | |
| to the child project (can be null). The key and value should both be strings.</param> | |
| <param name="targetOutputs">The outputs of each specified target (can be null).</param> | |
| <param name="toolsVersion">A tools version recognized by the Engine that will be used during this build (can be null).</param> | |
| <returns>true, if build was successful</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine2.BuildProjectFilesInParallel(System.String[],System.String[],System.Collections.IDictionary[],System.Collections.IDictionary[],System.String[],System.Boolean,System.Boolean)"> | |
| <summary> | |
| This method allows tasks to initiate a build on a | |
| particular project file. If the build is successful, the outputs | |
| (if any) of the specified targets are returned. | |
| </summary> | |
| <remarks> | |
| 1) it is acceptable to pass null for both <c>targetNames</c> and <c>targetOutputs</c> | |
| 2) if no targets are specified, the default targets are built | |
| 3) target outputs are returned as <c>ITaskItem</c> arrays indexed by target name | |
| </remarks> | |
| <param name="projectFileNames">The project to build.</param> | |
| <param name="targetNames">The targets in the project to build (can be null).</param> | |
| <param name="globalProperties">An array of hashtables of additional global properties to apply | |
| to the child project (array entries can be null). | |
| The key and value in the hashtable should both be strings.</param> | |
| <param name="targetOutputsPerProject">The outputs of each specified target (can be null).</param> | |
| <param name="toolsVersion">A tools version recognized by the Engine that will be used during this build (can be null).</param> | |
| <param name="useResultsCache">If true the operation will only be run if the cache doesn't | |
| already contain the result. After the operation the result is | |
| stored in the cache </param> | |
| <param name="unloadProjectsOnCompletion">If true the project will be unloaded once the | |
| operation is completed </param> | |
| <returns>true, if build was successful</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine3"> | |
| <summary> | |
| This interface extends IBuildEngine to provide a method allowing building | |
| project files in parallel. | |
| </summary> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This method allows tasks to initiate a build on a | |
| particular project file. If the build is successful, the outputs | |
| (if any) of the specified targets are returned. | |
| </summary> | |
| <remarks> | |
| 1) it is acceptable to pass null for both <c>targetNames</c> and <c>targetOutputs</c> | |
| 2) if no targets are specified, the default targets are built | |
| </remarks> | |
| <param name="projectFileNames">The project to build.</param> | |
| <param name="targetNames">The targets in the project to build (can be null).</param> | |
| <param name="globalProperties">An array of hashtables of additional global properties to apply | |
| to the child project (array entries can be null). | |
| The key and value in the hashtable should both be strings.</param> | |
| <param name="removeGlobalProperties">A list of global properties which should be removed.</param> | |
| <param name="toolsVersion">A tools version recognized by the Engine that will be used during this build (can be null).</param> | |
| <param name="returnTargetOutputs">Should the target outputs be returned in the BuildEngineResult</param> | |
| <returns>Returns a structure containing the success or failure of the build and the target outputs by project.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine3.Yield"> | |
| <summary> | |
| Informs the system that this task has a long-running out-of-process component and other work can be done in the | |
| build while that work completes. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine3.Reacquire"> | |
| <summary> | |
| Waits to reacquire control after yielding. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.RegisteredTaskObjectLifetime"> | |
| <summary> | |
| Defines the lifetime of a registered task object. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.RegisteredTaskObjectLifetime.Build"> | |
| <summary> | |
| The registered object will be disposed when the build ends. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.RegisteredTaskObjectLifetime.AppDomain"> | |
| <summary> | |
| The registered object will be disposed when the AppDomain is unloaded. | |
| </summary> | |
| <remarks> | |
| The AppDomain to which this refers is the one in which MSBuild was launched, | |
| not the one in which the Task was launched. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine4"> | |
| <summary> | |
| This interface extends IBuildEngine to provide a mechanism allowing tasks to | |
| share data between task invocations. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine4.RegisterTaskObject(System.Object,System.Object,Microsoft.Build.Framework.RegisteredTaskObjectLifetime,System.Boolean)"> | |
| <summary> | |
| Registers an object with the system that will be disposed of at some specified time | |
| in the future. | |
| </summary> | |
| <param name="key">The key used to retrieve the object.</param> | |
| <param name="obj">The object to be held for later disposal.</param> | |
| <param name="lifetime">The lifetime of the object.</param> | |
| <param name="allowEarlyCollection">The object may be disposed earlier that the requested time if | |
| MSBuild needs to reclaim memory.</param> | |
| <remarks> | |
| <para> | |
| This method may be called by tasks which need to maintain state across task invocations, | |
| such as to cache data which may be expensive to generate but which is known not to change during the | |
| build. It is strongly recommended that <paramref name="allowEarlyCollection"/> be set to true if the | |
| object will retain any significant amount of data, as this gives MSBuild the most flexibility to | |
| manage limited process memory resources. | |
| </para> | |
| <para> | |
| The thread on which the object is disposed may be arbitrary - however it is guaranteed not to | |
| be disposed while the task is executing, even if <paramref name="allowEarlyCollection"/> is set | |
| to true. | |
| </para> | |
| <para> | |
| If the object implements IDisposable, IDisposable.Dispose will be invoked on the object before | |
| discarding it. | |
| </para> | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine4.GetRegisteredTaskObject(System.Object,Microsoft.Build.Framework.RegisteredTaskObjectLifetime)"> | |
| <summary> | |
| Retrieves a previously registered task object stored with the specified key. | |
| </summary> | |
| <param name="key">The key used to retrieve the object.</param> | |
| <param name="lifetime">The lifetime of the object.</param> | |
| <returns> | |
| The registered object, or null is there is no object registered under that key or the object | |
| has been discarded through early collection. | |
| </returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine4.UnregisterTaskObject(System.Object,Microsoft.Build.Framework.RegisteredTaskObjectLifetime)"> | |
| <summary> | |
| Unregisters a previously-registered task object. | |
| </summary> | |
| <param name="key">The key used to retrieve the object.</param> | |
| <param name="lifetime">The lifetime of the object.</param> | |
| <returns> | |
| The registered object, or null is there is no object registered under that key or the object | |
| has been discarded through early collection. | |
| </returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine5"> | |
| <summary> | |
| This interface extends IBuildEngine to log telemetry. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine5.LogTelemetry(System.String,System.Collections.Generic.IDictionary{System.String,System.String})"> | |
| <summary> | |
| Logs telemetry. | |
| </summary> | |
| <param name="eventName">The event name.</param> | |
| <param name="properties">The event properties.</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine6"> | |
| <summary> | |
| This interface extends <see cref="T:Microsoft.Build.Framework.IBuildEngine5" /> to allow tasks to get the current project's global properties. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine6.GetGlobalProperties"> | |
| <summary> | |
| Gets the global properties for the current project. | |
| </summary> | |
| <returns>An <see cref="T:System.Collections.Generic.IReadOnlyDictionary`2" /> containing the global properties of the current project.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine7"> | |
| <summary> | |
| This interface extends <see cref="T:Microsoft.Build.Framework.IBuildEngine6" /> to allow tasks to set whether they want to | |
| log an error when a task returns without logging an error. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine8"> | |
| <summary> | |
| This interface extends <see cref="T:Microsoft.Build.Framework.IBuildEngine7" /> to let tasks know if a warning | |
| they are about to log will be converted into an error. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine8.ShouldTreatWarningAsError(System.String)"> | |
| <summary> | |
| Determines whether the logging service will convert the specified | |
| warning code into an error. | |
| </summary> | |
| <param name="warningCode">The warning code to check.</param> | |
| <returns>A boolean to determine whether the warning should be treated as an error.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IBuildEngine9"> | |
| <summary> | |
| This interface extends <see cref="T:Microsoft.Build.Framework.IBuildEngine8" /> to provide resource management API to tasks. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine9.RequestCores(System.Int32)"> | |
| <summary> | |
| If a task launches multiple parallel processes, it should ask how many cores it can use. | |
| </summary> | |
| <param name="requestedCores">The number of cores a task can potentially use.</param> | |
| <returns>The number of cores a task is allowed to use.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IBuildEngine9.ReleaseCores(System.Int32)"> | |
| <summary> | |
| A task should notify the build manager when all or some of the requested cores are not used anymore. | |
| When task is finished, the cores it requested are automatically released. | |
| </summary> | |
| <param name="coresToRelease">Number of cores no longer in use.</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ICancelableTask"> | |
| <summary> | |
| Interface for tasks which can be cancelled. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ICancelableTask.Cancel"> | |
| <summary> | |
| Instructs the task to exit as soon as possible, or to immediately exit if Execute is invoked after this method. | |
| </summary> | |
| <remarks> | |
| 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. | |
| Cancel calls may come in from any thread. The implementation of this method should not block indefinitely. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IEventRedirector"> | |
| <summary> | |
| This interface is used to forward events to another loggers | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IEventRedirector.ForwardEvent(Microsoft.Build.Framework.BuildEventArgs)"> | |
| <summary> | |
| This method is called by the node loggers to forward the events to central logger | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildMessageEventHandler"> | |
| <summary> | |
| Type of handler for MessageRaised events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildErrorEventHandler"> | |
| <summary> | |
| Type of handler for ErrorRaised events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildWarningEventHandler"> | |
| <summary> | |
| Type of handler for WarningRaised events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.CustomBuildEventHandler"> | |
| <summary> | |
| Type of handler for CustomEventRaised events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildStartedEventHandler"> | |
| <summary> | |
| Type of handler for BuildStartedEvent events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildFinishedEventHandler"> | |
| <summary> | |
| Type of handler for BuildFinishedEvent events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ProjectStartedEventHandler"> | |
| <summary> | |
| Type of handler for ProjectStarted events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ProjectFinishedEventHandler"> | |
| <summary> | |
| Type of handler for ProjectFinished events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TargetStartedEventHandler"> | |
| <summary> | |
| Type of handler for TargetStarted events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TargetFinishedEventHandler"> | |
| <summary> | |
| Type of handler for TargetFinished events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TaskStartedEventHandler"> | |
| <summary> | |
| Type of handler for TaskStarted events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TaskFinishedEventHandler"> | |
| <summary> | |
| Type of handler for TaskFinished events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.BuildStatusEventHandler"> | |
| <summary> | |
| Type of handler for BuildStatus events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.AnyEventHandler"> | |
| <summary> | |
| Type of handler for AnyEventRaised events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IEventSource"> | |
| <summary> | |
| This interface defines the events raised by the build engine. | |
| Loggers use this interface to subscribe to the events they | |
| are interested in receiving. | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.MessageRaised"> | |
| <summary> | |
| this event is raised to log a message | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.ErrorRaised"> | |
| <summary> | |
| this event is raised to log an error | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.WarningRaised"> | |
| <summary> | |
| this event is raised to log a warning | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.BuildStarted"> | |
| <summary> | |
| this event is raised to log the start of a build | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.BuildFinished"> | |
| <summary> | |
| this event is raised to log the end of a build | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.ProjectStarted"> | |
| <summary> | |
| this event is raised to log the start of a project build | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.ProjectFinished"> | |
| <summary> | |
| this event is raised to log the end of a project build | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.TargetStarted"> | |
| <summary> | |
| this event is raised to log the start of a target build | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.TargetFinished"> | |
| <summary> | |
| this event is raised to log the end of a target build | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.TaskStarted"> | |
| <summary> | |
| this event is raised to log the start of task execution | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.TaskFinished"> | |
| <summary> | |
| this event is raised to log the end of task execution | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.CustomEventRaised"> | |
| <summary> | |
| this event is raised to log custom events | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.StatusEventRaised"> | |
| <summary> | |
| this event is raised to log any build status event | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource.AnyEventRaised"> | |
| <summary> | |
| 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. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.EventSourceExtensions"> | |
| <summary> | |
| Helper methods for <see cref="T:Microsoft.Build.Framework.IEventSource"/> interface. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleMessageRaised(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.BuildMessageEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.MessageRaised"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleErrorRaised(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.BuildErrorEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.ErrorRaised"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleWarningRaised(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.BuildWarningEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.WarningRaised"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleBuildStarted(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.BuildStartedEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.BuildStarted"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleBuildFinished(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.BuildFinishedEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.BuildFinished"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleProjectStarted(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.ProjectStartedEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.ProjectStarted"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleProjectFinished(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.ProjectFinishedEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.ProjectFinished"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleTargetStarted(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.TargetStartedEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.TargetStarted"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleTargetFinished(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.TargetFinishedEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.TargetFinished"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleTaskStarted(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.TaskStartedEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.TaskStarted"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleTaskFinished(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.TaskFinishedEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.TaskFinished"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleCustomEventRaised(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.CustomBuildEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.CustomEventRaised"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleStatusEventRaised(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.BuildStatusEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.StatusEventRaised"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EventSourceExtensions.HandleAnyEventRaised(Microsoft.Build.Framework.IEventSource,Microsoft.Build.Framework.AnyEventHandler)"> | |
| <summary> | |
| Helper method ensuring single deduplicated subscription to the <see cref="E:Microsoft.Build.Framework.IEventSource.AnyEventRaised"/> event. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="handler">Handler to the event. If this handler is already subscribed, single subscription will be ensured.</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TelemetryEventHandler"> | |
| <summary> | |
| Type of handler for TelemetryLogged events | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IEventSource2"> | |
| <summary> | |
| This interface defines the events raised by the build engine. | |
| Loggers use this interface to subscribe to the events they | |
| are interested in receiving. | |
| </summary> | |
| </member> | |
| <member name="E:Microsoft.Build.Framework.IEventSource2.TelemetryLogged"> | |
| <summary> | |
| this event is raised to when telemetry is logged. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IEventSource3"> | |
| <summary> | |
| This interface defines the events raised by the build engine. | |
| Loggers use this interface to subscribe to the events they | |
| are interested in receiving. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IEventSource3.IncludeEvaluationMetaprojects"> | |
| <summary> | |
| Should evaluation events include generated metaprojects? | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IEventSource3.IncludeEvaluationProfiles"> | |
| <summary> | |
| Should evaluation events include profiling information? | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IEventSource3.IncludeTaskInputs"> | |
| <summary> | |
| Should task events include task inputs? | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IEventSource4"> | |
| <summary> | |
| This interface defines the events raised by the build engine. | |
| Loggers use this interface to subscribe to the events they | |
| are interested in receiving. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IEventSource4.IncludeEvaluationPropertiesAndItems"> | |
| <summary> | |
| Determines whether properties and items should be logged on <see cref="T:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs"/> | |
| instead of <see cref="T:Microsoft.Build.Framework.ProjectStartedEventArgs"/>. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IExtendedBuildEventArgs"> | |
| <summary> | |
| Interface for Extended EventArgs to allow enriching particular events with extended data. | |
| Deriving from EventArgs will be deprecated soon and using Extended EventArgs is recommended for custom Event Args. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedType"> | |
| <summary> | |
| Unique string identifying type of extended data so receiver side knows how to interpret, deserialize and handle <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedData"/>. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedMetadata"> | |
| <summary> | |
| Metadata of <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedData"/>. | |
| Example usage: | |
| - data which needed in custom code to properly routing this message without interpreting/deserializing <see cref="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedData"/>. | |
| - simple extended data can be transferred in form of dictionary key-value per one extended property. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IExtendedBuildEventArgs.ExtendedData"> | |
| <summary> | |
| Transparent data as string. | |
| Custom code is responsible to serialize and deserialize this string to structured data - if needed. | |
| Custom code can use any serialization they deem safe - e.g. json for textual data, base64 for binary data... | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IForwardingLogger"> | |
| <summary> | |
| This interface extends the ILogger interface to provide a property which can be used to forward events | |
| to a logger running in a different process. It can also be used to create filtering loggers. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IForwardingLogger.BuildEventRedirector"> | |
| <summary> | |
| This property is set by the build engine to allow a node loggers to forward messages to the | |
| central logger | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IForwardingLogger.NodeId"> | |
| <summary> | |
| This property is set by the build engine or node to inform the forwarding logger which node it is running on | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IGeneratedTask"> | |
| <summary> | |
| An interface implemented by tasks that are generated by ITaskFactory instances. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IGeneratedTask.SetPropertyValue(Microsoft.Build.Framework.TaskPropertyInfo,System.Object)"> | |
| <summary> | |
| Sets a value on a property of this task instance. | |
| </summary> | |
| <param name="property">The property to set.</param> | |
| <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> | |
| <remarks> | |
| All exceptions from this method will be caught in the taskExecution host and logged as a fatal task error | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IGeneratedTask.GetPropertyValue(Microsoft.Build.Framework.TaskPropertyInfo)"> | |
| <summary> | |
| Gets the property value. | |
| </summary> | |
| <param name="property">The property to get.</param> | |
| <returns> | |
| The value of the property, the value's type will match the type given by <see cref="P:Microsoft.Build.Framework.TaskPropertyInfo.PropertyType"/>. | |
| </returns> | |
| <remarks> | |
| MSBuild calls this method after executing the task to get output parameters. | |
| All exceptions from this method will be caught in the taskExecution host and logged as a fatal task error | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IIncrementalTask"> | |
| <summary> | |
| Interface for tasks which is supports incrementality. | |
| </summary> | |
| <remarks>The tasks implementing this interface should return false to stop the build when in <see cref="P:Microsoft.Build.Framework.IIncrementalTask.FailIfNotIncremental"/> is true and task is not fully incremental. Try to provide helpful information to diagnose incremental behavior.</remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IIncrementalTask.FailIfNotIncremental"> | |
| <summary> | |
| Set by MSBuild when Question flag is used. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.LoggerVerbosity"> | |
| <summary> | |
| Enumeration of the levels of detail of an event log. | |
| </summary> | |
| <remarks> | |
| The level of detail (i.e. verbosity) of an event log is entirely controlled by the logger generating the log -- a logger | |
| will be directed to keep its verbosity at a certain level, based on user preferences, but a logger is free to choose the | |
| events it logs for each verbosity level. | |
| LOGGING GUIDELINES FOR EACH VERBOSITY LEVEL: | |
| 1) Quiet -- only display a summary at the end of build | |
| 2) Minimal -- only display errors, warnings, high importance events and a build summary | |
| 3) Normal -- display all errors, warnings, high importance events, some status events, and a build summary | |
| 4) Detailed -- display all errors, warnings, high and normal importance events, all status events, and a build summary | |
| 5) Diagnostic -- display all events, and a build summary | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Quiet"> | |
| <summary> | |
| The most minimal output | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Minimal"> | |
| <summary> | |
| Relatively little output | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Normal"> | |
| <summary> | |
| Standard output. This should be the default if verbosity level is not set | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Detailed"> | |
| <summary> | |
| Relatively verbose, but not exhaustive | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.LoggerVerbosity.Diagnostic"> | |
| <summary> | |
| The most verbose and informative verbosity | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ILogger"> | |
| <summary> | |
| This interface defines a "logger" in the build system. A logger subscribes to build system events. All logger classes must | |
| implement this interface to be recognized by the build engine. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ILogger.Verbosity"> | |
| <summary> | |
| The verbosity level directs the amount of detail that appears in a logger's event log. Though this is only a | |
| recommendation based on user preferences, and a logger is free to choose the exact events it logs, it is still | |
| important that the guidelines for each level be followed, for a good user experience. | |
| </summary> | |
| <value>The verbosity level.</value> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ILogger.Parameters"> | |
| <summary> | |
| This property holds the user-specified parameters to the logger. If parameters are not provided, a logger should revert | |
| to defaults. If a logger does not take parameters, it can ignore this property. | |
| </summary> | |
| <value>The parameter string (can be null).</value> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ILogger.Initialize(Microsoft.Build.Framework.IEventSource)"> | |
| <summary> | |
| Called by the build engine to allow loggers to subscribe to the events they desire. | |
| </summary> | |
| <param name="eventSource">The events available to loggers.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ILogger.Shutdown"> | |
| <summary> | |
| Called by the build engine to allow loggers to release any resources they may have allocated at initialization time, | |
| or during the build. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IMetadataContainer"> | |
| <summary> | |
| Provides a way to efficiently enumerate item metadata | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IMetadataContainer.EnumerateMetadata"> | |
| <summary> | |
| Returns a list of metadata names and unescaped values, including | |
| metadata from item definition groups, but not including built-in | |
| metadata. Implementations should be low-overhead as the method | |
| is used for serialization (in node packet translator) as well as | |
| in the binary logger. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IMetadataContainer.ImportMetadata(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})"> | |
| <summary> | |
| Sets the given metadata. The operation is equivalent to calling | |
| <see cref="M:Microsoft.Build.Framework.ITaskItem.SetMetadata(System.String,System.String)"/> on all metadata, but takes | |
| advantage of a faster bulk-set operation where applicable. The | |
| implementation may not perform the same parameter validation | |
| as SetMetadata. | |
| </summary> | |
| <param name="metadata">The metadata to set. The keys are assumed | |
| to be unique and values are assumed to be escaped. | |
| </param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ImmutableFilesTimestampCache"> | |
| <summary> | |
| Caching 'Last Write File Utc' times for Immutable files <see cref="T:Microsoft.Build.Framework.FileClassifier" />. | |
| </summary> | |
| <remarks> | |
| Cache is add only. It does not updates already existing cached items. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ImmutableFilesTimestampCache.Shared"> | |
| <summary> | |
| Shared singleton instance | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ImmutableFilesTimestampCache.TryGetValue(System.String,System.DateTime@)"> | |
| <summary> | |
| Try get 'Last Write File Utc' time of particular file. | |
| </summary> | |
| <returns><see langword="true" /> if record exists</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ImmutableFilesTimestampCache.TryAdd(System.String,System.DateTime)"> | |
| <summary> | |
| Try Add 'Last Write File Utc' time of particular file into cache. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.INodeLogger"> | |
| <summary> | |
| This interface defines a "parallel aware logger" in the build system. A parallel aware logger | |
| will accept a cpu count and be aware that any cpu count greater than 1 means the events will | |
| be received from the logger from each cpu as the events are logged. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.INodeLogger.Initialize(Microsoft.Build.Framework.IEventSource,System.Int32)"> | |
| <summary> | |
| Initializes the current <see cref="T:Microsoft.Build.Framework.INodeLogger"/> instance. | |
| </summary> | |
| <param name="eventSource"></param> | |
| <param name="nodeCount"></param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.InternalErrorException"> | |
| <summary> | |
| This exception is to be thrown whenever an assumption we have made in the code turns out to be false. Thus, if this | |
| exception ever gets thrown, it is because of a bug in our own code, not because of something the user or project author | |
| did wrong. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.InternalErrorException.#ctor"> | |
| <summary> | |
| Default constructor. | |
| SHOULD ONLY BE CALLED BY DESERIALIZER. | |
| SUPPLY A MESSAGE INSTEAD. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.InternalErrorException.#ctor(System.String)"> | |
| <summary> | |
| Creates an instance of this exception using the given message. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.InternalErrorException.#ctor(System.String,System.Exception)"> | |
| <summary> | |
| Creates an instance of this exception using the given message and inner exception. | |
| Adds the inner exception's details to the exception message because most bug reporters don't bother | |
| to provide the inner exception details which is typically what we care about. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.InternalErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> | |
| <summary> | |
| Private constructor used for (de)serialization. The constructor is private as this class is sealed | |
| If we ever add new members to this class, we'll need to update this. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.InternalErrorException.ConsiderDebuggerLaunch(System.String,System.Exception)"> | |
| <summary> | |
| A fatal internal error due to a bug has occurred. Give the dev a chance to debug it, if possible. | |
| Will in all cases launch the debugger, if the environment variable "MSBUILDLAUNCHDEBUGGER" is set. | |
| In DEBUG build, will always launch the debugger, unless we are in razzle (_NTROOT is set) or in NUnit, | |
| or MSBUILDDONOTLAUNCHDEBUGGER is set (that could be useful in suite runs). | |
| We don't launch in retail or LKG so builds don't jam; they get a callstack, and continue or send a mail, etc. | |
| We don't launch in NUnit as tests often intentionally cause InternalErrorExceptions. | |
| Because we only call this method from this class, just before throwing an InternalErrorException, there is | |
| no danger that this suppression will cause a bug to only manifest itself outside NUnit | |
| (which would be most unfortunate!). Do not make this non-private. | |
| Unfortunately NUnit can't handle unhandled exceptions like InternalErrorException on anything other than | |
| the main test thread. However, there's still a callstack displayed before it quits. | |
| If it is going to launch the debugger, it first does a Debug.Fail to give information about what needs to | |
| be debugged -- the exception hasn't been thrown yet. This automatically displays the current callstack. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IProjectElement"> | |
| <summary> | |
| Interface for exposing a ProjectElement to the appropriate loggers | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IProjectElement.ElementName"> | |
| <summary> | |
| Gets the name of the associated element. | |
| Useful for display in some circumstances. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.IProjectElement.OuterElement"> | |
| <summary> | |
| The outer markup associated with this project element | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.IStringBuilderProvider"> | |
| <summary> | |
| Provider of <see cref="T:System.Text.StringBuilder"/> instances. | |
| Main design goal is for reusable String Builders and string builder pools. | |
| </summary> | |
| <remarks> | |
| It is up to particular implementations to decide how to handle unbalanced releases. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IStringBuilderProvider.Acquire(System.Int32)"> | |
| <summary> | |
| Get a <see cref="T:System.Text.StringBuilder"/> of at least the specified capacity. | |
| </summary> | |
| <param name="capacity">The suggested starting size of this instance.</param> | |
| <returns>A <see cref="T:System.Text.StringBuilder"/> that may or may not be reused.</returns> | |
| <remarks> | |
| It can be called any number of times; if a <see cref="T:System.Text.StringBuilder"/> is in the cache then | |
| it will be returned and the cache emptied. Subsequent calls will return a new <see cref="T:System.Text.StringBuilder"/>. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.IStringBuilderProvider.GetStringAndRelease(System.Text.StringBuilder)"> | |
| <summary> | |
| Get a string and return its builder to the cache. | |
| </summary> | |
| <param name="builder">Builder to cache (if it's not too big).</param> | |
| <returns>The <see langword="string"/> equivalent to <paramref name="builder"/>'s contents.</returns> | |
| <remarks> | |
| The StringBuilder should not be used after it has been released. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ITask"> | |
| <summary> | |
| This interface defines a "task" in the build system. A task is an atomic unit of build operation. All task classes must | |
| implement this interface to be recognized by the build engine. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ITask.BuildEngine"> | |
| <summary> | |
| This property is set by the build engine to allow a task to call back into it. | |
| </summary> | |
| <value>The interface on the build engine available to tasks.</value> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ITask.HostObject"> | |
| <summary> | |
| The build engine sets this property if the host IDE has associated a host object with this particular task. | |
| </summary> | |
| <value>The host object instance (can be null).</value> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITask.Execute"> | |
| <summary> | |
| This method is called by the build engine to begin task execution. A task uses the return value to indicate | |
| whether it was successful. If a task throws an exception out of this method, the engine will automatically | |
| assume that the task has failed. | |
| </summary> | |
| <returns>true, if successful</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ITaskFactory"> | |
| <summary> | |
| Interface that a task factory Instance should implement | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ITaskFactory.FactoryName"> | |
| <summary> | |
| Gets the name of the factory. | |
| </summary> | |
| <value>The name of the factory.</value> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ITaskFactory.TaskType"> | |
| <summary> | |
| Gets the type of the task this factory will instantiate. Implementations must return a value for this property. | |
| </summary> | |
| </member> | |
| <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)"> | |
| <summary> | |
| Initializes this factory for instantiating tasks with a particular inline task block. | |
| </summary> | |
| <param name="taskName">Name of the task.</param> | |
| <param name="parameterGroup">The parameter group.</param> | |
| <param name="taskBody">The task body.</param> | |
| <param name="taskFactoryLoggingHost">The task factory logging host.</param> | |
| <returns>A value indicating whether initialization was successful.</returns> | |
| <remarks> | |
| <para>MSBuild engine will call this to initialize the factory. This should initialize the factory enough so that the factory can be asked | |
| whether or not task names can be created by the factory.</para> | |
| <para> | |
| The taskFactoryLoggingHost will log messages in the context of the target where the task is first used. | |
| </para> | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskFactory.GetTaskParameters"> | |
| <summary> | |
| Get the descriptions for all the task's parameters. | |
| </summary> | |
| <returns>A non-null array of property descriptions.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskFactory.CreateTask(Microsoft.Build.Framework.IBuildEngine)"> | |
| <summary> | |
| Create an instance of the task to be used. | |
| </summary> | |
| <param name="taskFactoryLoggingHost"> | |
| The task factory logging host will log messages in the context of the task. | |
| </param> | |
| <returns> | |
| The generated task, or <c>null</c> if the task failed to be created. | |
| </returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskFactory.CleanupTask(Microsoft.Build.Framework.ITask)"> | |
| <summary> | |
| Cleans up any context or state that may have been built up for a given task. | |
| </summary> | |
| <param name="task">The task to clean up.</param> | |
| <remarks> | |
| For many factories, this method is a no-op. But some factories may have built up | |
| an AppDomain as part of an individual task instance, and this is their opportunity | |
| to shutdown the AppDomain. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ITaskFactory2"> | |
| <summary> | |
| Interface that a task factory Instance should implement if it wants to be able to | |
| use new UsingTask parameters such as Runtime and Architecture. | |
| </summary> | |
| </member> | |
| <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)"> | |
| <summary> | |
| Initializes this factory for instantiating tasks with a particular inline task block and a set of UsingTask parameters. MSBuild | |
| provides an implementation of this interface, TaskHostFactory, that uses "Runtime", with values "CLR2", "CLR4", "CurrentRuntime", | |
| and "*" (Any); and "Architecture", with values "x86", "x64", "CurrentArchitecture", and "*" (Any). An implementer of ITaskFactory2 | |
| can choose to use these pre-defined Runtime and Architecture values, or can specify new values for these parameters. | |
| </summary> | |
| <param name="taskName">Name of the task.</param> | |
| <param name="factoryIdentityParameters">Special parameters that the task factory can use to modify how it executes tasks, | |
| such as Runtime and Architecture. The key is the name of the parameter and the value is the parameter's value. This | |
| is the set of parameters that was set on the UsingTask using e.g. the UsingTask Runtime and Architecture parameters.</param> | |
| <param name="parameterGroup">The parameter group.</param> | |
| <param name="taskBody">The task body.</param> | |
| <param name="taskFactoryLoggingHost">The task factory logging host.</param> | |
| <returns>A value indicating whether initialization was successful.</returns> | |
| <remarks> | |
| <para>MSBuild engine will call this to initialize the factory. This should initialize the factory enough so that the | |
| factory can be asked whether or not task names can be created by the factory. If a task factory implements ITaskFactory2, | |
| this Initialize method will be called in place of ITaskFactory.Initialize.</para> | |
| <para> | |
| The taskFactoryLoggingHost will log messages in the context of the target where the task is first used. | |
| </para> | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskFactory2.CreateTask(Microsoft.Build.Framework.IBuildEngine,System.Collections.Generic.IDictionary{System.String,System.String})"> | |
| <summary> | |
| Create an instance of the task to be used, with an optional set of "special" parameters set on the individual task invocation using | |
| the MSBuildRuntime and MSBuildArchitecture default task parameters. MSBuild provides an implementation of this interface, | |
| TaskHostFactory, that uses "MSBuildRuntime", with values "CLR2", "CLR4", "CurrentRuntime", and "*" (Any); and "MSBuildArchitecture", | |
| with values "x86", "x64", "CurrentArchitecture", and "*" (Any). An implementer of ITaskFactory2 can choose to use these pre-defined | |
| MSBuildRuntime and MSBuildArchitecture values, or can specify new values for these parameters. | |
| </summary> | |
| <param name="taskFactoryLoggingHost"> | |
| The task factory logging host will log messages in the context of the task. | |
| </param> | |
| <param name="taskIdentityParameters"> | |
| Special parameters that the task factory can use to modify how it executes tasks, such as Runtime and Architecture. | |
| The key is the name of the parameter and the value is the parameter's value. This is the set of parameters that was | |
| set to the task invocation itself, via e.g. the special MSBuildRuntime and MSBuildArchitecture parameters. | |
| </param> | |
| <remarks> | |
| If a task factory implements ITaskFactory2, MSBuild will call this method instead of ITaskFactory.CreateTask. | |
| </remarks> | |
| <returns> | |
| The generated task, or <c>null</c> if the task failed to be created. | |
| </returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ITaskHost"> | |
| <summary> | |
| This empty interface is used to pass host objects from an IDE to individual | |
| tasks. Depending on the task itself and what kinds parameters and functionality | |
| it exposes, the task should define its own interface that inherits from this one, | |
| and then use that interface to communicate with the host. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ITaskItem"> | |
| <summary> | |
| This interface defines a project item that can be consumed and emitted by tasks. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ITaskItem.ItemSpec"> | |
| <summary> | |
| Gets or sets the item "specification" e.g. for disk-based items this would be the file path. | |
| </summary> | |
| <remarks> | |
| This should be named "EvaluatedInclude" but that would be a breaking change to this interface. | |
| </remarks> | |
| <value>The item-spec string.</value> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ITaskItem.MetadataNames"> | |
| <summary> | |
| Gets the names of all the metadata on the item. | |
| Includes the built-in metadata like "FullPath". | |
| </summary> | |
| <value>The list of metadata names.</value> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ITaskItem.MetadataCount"> | |
| <summary> | |
| Gets the number of pieces of metadata on the item. Includes | |
| both custom and built-in metadata. | |
| </summary> | |
| <value>Count of pieces of metadata.</value> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskItem.GetMetadata(System.String)"> | |
| <summary> | |
| Allows the values of metadata on the item to be queried. | |
| </summary> | |
| <param name="metadataName">The name of the metadata to retrieve.</param> | |
| <returns>The value of the specified metadata.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskItem.SetMetadata(System.String,System.String)"> | |
| <summary> | |
| Allows a piece of custom metadata to be set on the item. | |
| </summary> | |
| <param name="metadataName">The name of the metadata to set.</param> | |
| <param name="metadataValue">The metadata value.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskItem.RemoveMetadata(System.String)"> | |
| <summary> | |
| Allows the removal of custom metadata set on the item. | |
| </summary> | |
| <param name="metadataName">The name of the metadata to remove.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskItem.CopyMetadataTo(Microsoft.Build.Framework.ITaskItem)"> | |
| <summary> | |
| Allows custom metadata on the item to be copied to another item. | |
| </summary> | |
| <remarks> | |
| RECOMMENDED GUIDELINES FOR METHOD IMPLEMENTATIONS: | |
| 1) this method should NOT copy over the item-spec | |
| 2) if a particular piece of metadata already exists on the destination item, it should NOT be overwritten | |
| 3) if there are pieces of metadata on the item that make no semantic sense on the destination item, they should NOT be copied | |
| </remarks> | |
| <param name="destinationItem">The item to copy metadata to.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskItem.CloneCustomMetadata"> | |
| <summary> | |
| Get the collection of custom metadata. This does not include built-in metadata. | |
| </summary> | |
| <remarks> | |
| RECOMMENDED GUIDELINES FOR METHOD IMPLEMENTATIONS: | |
| 1) this method should return a clone of the metadata | |
| 2) writing to this dictionary should not be reflected in the underlying item. | |
| </remarks> | |
| <returns>Dictionary of cloned metadata</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ITaskItem2"> | |
| <summary> | |
| This interface adds escaping support to the ITaskItem interface. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ITaskItem2.EvaluatedIncludeEscaped"> | |
| <summary> | |
| Gets or sets the item include value e.g. for disk-based items this would be the file path. | |
| </summary> | |
| <remarks> | |
| Taking the opportunity to fix the property name, although this doesn't | |
| make it obvious it's an improvement on ItemSpec. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskItem2.GetMetadataValueEscaped(System.String)"> | |
| <summary> | |
| Allows the values of metadata on the item to be queried. | |
| </summary> | |
| <remarks> | |
| Taking the opportunity to fix the property name, although this doesn't | |
| make it obvious it's an improvement on GetMetadata. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskItem2.SetMetadataValueLiteral(System.String,System.String)"> | |
| <summary> | |
| Allows a piece of custom metadata to be set on the item. Assumes that the value passed | |
| in is unescaped, and escapes the value as necessary in order to maintain its value. | |
| </summary> | |
| <remarks> | |
| Taking the opportunity to fix the property name, although this doesn't | |
| make it obvious it's an improvement on SetMetadata. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskItem2.CloneCustomMetadataEscaped"> | |
| <summary> | |
| ITaskItem2 implementation which returns a clone of the metadata on this object. | |
| Values returned are in their original escaped form. | |
| </summary> | |
| <returns>The cloned metadata, with values' escaping preserved.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ITaskItemExtensions.EnumerateMetadata(Microsoft.Build.Framework.ITaskItem)"> | |
| <summary> | |
| Provides a way to efficiently enumerate custom metadata of an item, without built-in metadata. | |
| </summary> | |
| <param name="taskItem">TaskItem implementation to return metadata from</param> | |
| <remarks>WARNING: do NOT use List`1.AddRange to iterate over this collection. | |
| CopyOnWriteDictionary from Microsoft.Build.Utilities.v4.0.dll is broken.</remarks> | |
| <returns>A non-null (but possibly empty) enumerable of item metadata.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.LazyFormattedBuildEventArgs"> | |
| <summary> | |
| Stores strings for parts of a message delaying the formatting until it needs to be shown | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.argumentsOrFormattedMessage"> | |
| <summary> | |
| Stores the message arguments. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.RawArguments"> | |
| <summary> | |
| Exposes the underlying arguments field to serializers. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.FormattedMessage"> | |
| <summary> | |
| Exposes the formatted message string to serializers. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.#ctor(System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows all event data to be initialized. | |
| </summary> | |
| <param name="message">text message.</param> | |
| <param name="helpKeyword">help keyword.</param> | |
| <param name="senderName">name of event sender.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.#ctor(System.String,System.String,System.String,System.DateTime,System.Object[])"> | |
| <summary> | |
| This constructor that allows message arguments that are lazily formatted. | |
| </summary> | |
| <param name="message">text message.</param> | |
| <param name="helpKeyword">help keyword.</param> | |
| <param name="senderName">name of event sender.</param> | |
| <param name="eventTimestamp">Timestamp when event was created.</param> | |
| <param name="messageArgs">Message arguments.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.#ctor"> | |
| <summary> | |
| Default constructor. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.Message"> | |
| <summary> | |
| Gets the formatted message. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer. | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes from a stream through a binary reader. | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from.</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LazyFormattedBuildEventArgs.FormatString(System.String,System.Object[])"> | |
| <summary> | |
| Formats the given string using the variable arguments passed in. | |
| PERF WARNING: calling a method that takes a variable number of arguments is expensive, because memory is allocated for | |
| the array of arguments -- do not call this method repeatedly in performance-critical scenarios | |
| </summary> | |
| <remarks>This method is thread-safe.</remarks> | |
| <param name="unformatted">The string to format.</param> | |
| <param name="args">Optional arguments for formatting the given string.</param> | |
| <returns>The formatted string.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.LoadInSeparateAppDomainAttribute"> | |
| <summary> | |
| 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 | |
| domain each time it needs to run such a task, and immediately unload it when the task is finished. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LoadInSeparateAppDomainAttribute.#ctor"> | |
| <summary> | |
| Default constructor. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.LoggerException"> | |
| <summary> | |
| Exception that should be thrown by a logger when it cannot continue. | |
| Allows a logger to force the build to stop in an explicit way, when, for example, it | |
| receives invalid parameters, or cannot write to disk. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LoggerException.#ctor"> | |
| <summary> | |
| Default constructor. | |
| </summary> | |
| <remarks> | |
| This constructor only exists to satisfy .NET coding guidelines. Use the rich constructor instead. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LoggerException.#ctor(System.String)"> | |
| <summary> | |
| Creates an instance of this exception using the specified error message. | |
| </summary> | |
| <param name="message">Message string</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LoggerException.#ctor(System.String,System.Exception)"> | |
| <summary> | |
| Creates an instance of this exception using the specified error message and inner exception. | |
| </summary> | |
| <param name="message">Message string</param> | |
| <param name="innerException">Inner exception. Can be null</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LoggerException.#ctor(System.String,System.Exception,System.String,System.String)"> | |
| <summary> | |
| Creates an instance of this exception using rich error information. | |
| </summary> | |
| <param name="message">Message string</param> | |
| <param name="innerException">Inner exception. Can be null</param> | |
| <param name="errorCode">Error code</param> | |
| <param name="helpKeyword">Help keyword for host IDE. Can be null</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LoggerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> | |
| <summary> | |
| Protected constructor used for (de)serialization. | |
| If we ever add new members to this class, we'll need to update this. | |
| </summary> | |
| <param name="info">Serialization info</param> | |
| <param name="context">Streaming context</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.LoggerException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> | |
| <summary> | |
| ISerializable method which we must override since Exception implements this interface | |
| If we ever add new members to this class, we'll need to update this. | |
| </summary> | |
| <param name="info">Serialization info</param> | |
| <param name="context">Streaming context</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.LoggerException.ErrorCode"> | |
| <summary> | |
| Gets the error code associated with this exception's message (not the inner exception). | |
| </summary> | |
| <value>The error code string.</value> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.LoggerException.HelpKeyword"> | |
| <summary> | |
| Gets the F1-help keyword associated with this error, for the host IDE. | |
| </summary> | |
| <value>The keyword string.</value> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.MetaprojectGeneratedEventArgs"> | |
| <summary> | |
| Arguments for the metaproject generated event. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.MetaprojectGeneratedEventArgs.metaprojectXml"> | |
| <summary> | |
| Raw xml representing the metaproject. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.MetaprojectGeneratedEventArgs.#ctor(System.String,System.String,System.String)"> | |
| <summary> | |
| Initializes a new instance of the MetaprojectGeneratedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MAX_PATH"> | |
| <summary> | |
| Default buffer size to use when dealing with the Windows API. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.NativeMethods.COWAIT_FLAGS"> | |
| <summary> | |
| Flags for CoWaitForMultipleHandles | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.COWAIT_FLAGS.COWAIT_NONE"> | |
| <summary> | |
| Exit when a handle is signaled. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.COWAIT_FLAGS.COWAIT_WAITALL"> | |
| <summary> | |
| Exit when all handles are signaled AND a message is received. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.COWAIT_FLAGS.COWAIT_ALERTABLE"> | |
| <summary> | |
| Exit when an RPC call is serviced. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.NativeMethods.ProcessorArchitectures"> | |
| <summary> | |
| Processor architecture values | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.NativeMethods.SYSTEM_INFO"> | |
| <summary> | |
| Structure that contain information about the system on which we are running | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.NativeMethods.SafeProcessHandle"> | |
| <summary> | |
| Wrap the intptr returned by OpenProcess in a safe handle. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.NativeMethods.MemoryStatus"> | |
| <summary> | |
| Contains information about the current state of both physical and virtual memory, including extended memory | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.MemoryStatus.#ctor"> | |
| <summary> | |
| Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.NativeMethods.MemoryStatus"/> class. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MemoryStatus._length"> | |
| <summary> | |
| Size of the structure, in bytes. You must set this member before calling GlobalMemoryStatusEx. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MemoryStatus.MemoryLoad"> | |
| <summary> | |
| Number between 0 and 100 that specifies the approximate percentage of physical | |
| memory that is in use (0 indicates no memory use and 100 indicates full memory use). | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MemoryStatus.TotalPhysical"> | |
| <summary> | |
| Total size of physical memory, in bytes. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MemoryStatus.AvailablePhysical"> | |
| <summary> | |
| Size of physical memory available, in bytes. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MemoryStatus.TotalPageFile"> | |
| <summary> | |
| Size of the committed memory limit, in bytes. This is physical memory plus the | |
| size of the page file, minus a small overhead. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MemoryStatus.AvailablePageFile"> | |
| <summary> | |
| Size of available memory to commit, in bytes. The limit is ullTotalPageFile. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MemoryStatus.TotalVirtual"> | |
| <summary> | |
| Total size of the user mode portion of the virtual address space of the calling process, in bytes. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MemoryStatus.AvailableVirtual"> | |
| <summary> | |
| Size of unreserved and uncommitted memory in the user mode portion of the virtual | |
| address space of the calling process, in bytes. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.MemoryStatus.AvailableExtendedVirtual"> | |
| <summary> | |
| Size of unreserved and uncommitted memory in the extended portion of the virtual | |
| address space of the calling process, in bytes. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.NativeMethods.WIN32_FILE_ATTRIBUTE_DATA"> | |
| <summary> | |
| Contains information about a file or directory; used by GetFileAttributesEx. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.NativeMethods.SecurityAttributes"> | |
| <summary> | |
| Contains the security descriptor for an object and specifies whether | |
| the handle retrieved by specifying this structure is inheritable. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.SystemInformationData.ProcessorArchitectureType"> | |
| <summary> | |
| Architecture as far as the current process is concerned. | |
| It's x86 in wow64 (native architecture is x64 in that case). | |
| Otherwise it's the same as the native architecture. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.SystemInformationData.ProcessorArchitectureTypeNative"> | |
| <summary> | |
| Actual architecture of the system. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.SystemInformationData.ConvertSystemArchitecture(System.UInt16)"> | |
| <summary> | |
| Convert SYSTEM_INFO architecture values to the internal enum | |
| </summary> | |
| <param name="arch"></param> | |
| <returns></returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.SystemInformationData.#ctor"> | |
| <summary> | |
| Read system info values | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetLogicalCoreCountOnWindows"> | |
| <summary> | |
| Get the exact physical core count on Windows | |
| Useful for getting the exact core count in 32 bits processes, | |
| as Environment.ProcessorCount has a 32-core limit in that case. | |
| https://github.com/dotnet/runtime/blob/221ad5b728f93489655df290c1ea52956ad8f51c/src/libraries/System.Runtime.Extensions/src/System/Environment.Windows.cs#L171-L210 | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.MaxPath"> | |
| <summary> | |
| Gets the max path limit of the current OS. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods._maxPath"> | |
| <summary> | |
| Cached value for MaxPath. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.s_isUnixLike"> | |
| <summary> | |
| Cached value for IsUnixLike (this method is called frequently during evaluation). | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.IsUnixLike"> | |
| <summary> | |
| Gets a flag indicating if we are running under a Unix-like system (Mac, Linux, etc.) | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.IsLinux"> | |
| <summary> | |
| Gets a flag indicating if we are running under Linux | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.IsBSD"> | |
| <summary> | |
| Gets a flag indicating if we are running under flavor of BSD (NetBSD, OpenBSD, FreeBSD) | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.IsWindows"> | |
| <summary> | |
| Gets a flag indicating if we are running under some version of Windows | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.IsOSX"> | |
| <summary> | |
| Gets a flag indicating if we are running under Mac OSX | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.OSName"> | |
| <summary> | |
| Gets a string for the current OS. This matches the OS env variable | |
| for Windows (Windows_NT). | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.FrameworkName"> | |
| <summary> | |
| Framework named as presented to users (for example in version info). | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetOSNameForExtensionsPath"> | |
| <summary> | |
| OS name that can be used for the msbuildExtensionsPathSearchPaths element | |
| for a toolset | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.s_frameworkBasePath"> | |
| <summary> | |
| The base directory for all framework paths in Mono | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.NativeMethods.s_frameworkCurrentPath"> | |
| <summary> | |
| The directory of the current framework | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.FrameworkCurrentPath"> | |
| <summary> | |
| Gets the currently running framework path | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.FrameworkBasePath"> | |
| <summary> | |
| Gets the base directory of all Mono frameworks | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.SystemInformation"> | |
| <summary> | |
| System information, initialized when required. | |
| </summary> | |
| <remarks> | |
| Initially implemented as <see cref="T:System.Lazy`1"/>, but | |
| that's .NET 4+, and this is used in MSBuildTaskHost. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.ProcessorArchitecture"> | |
| <summary> | |
| Architecture getter | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.NativeMethods.ProcessorArchitectureNative"> | |
| <summary> | |
| Native architecture getter | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetLastWriteDirectoryUtcTime(System.String,System.DateTime@)"> | |
| <summary> | |
| Get the last write time of the fullpath to a directory. If the pointed path is not a directory, or | |
| if the directory does not exist, then false is returned and fileModifiedTimeUtc is set DateTime.MinValue. | |
| </summary> | |
| <param name="fullPath">Full path to the file in the filesystem</param> | |
| <param name="fileModifiedTimeUtc">The UTC last write time for the directory</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetShortFilePath(System.String)"> | |
| <summary> | |
| Takes the path and returns the short path | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetLongFilePath(System.String)"> | |
| <summary> | |
| Takes the path and returns a full path | |
| </summary> | |
| <param name="path"></param> | |
| <returns></returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetMemoryStatus"> | |
| <summary> | |
| Retrieves the current global memory status. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetLastWriteFileUtcTime(System.String)"> | |
| <summary> | |
| Get the last write time of the fullpath to the file. | |
| </summary> | |
| <param name="fullPath">Full path to the file in the filesystem</param> | |
| <returns>The last write time of the file, or DateTime.MinValue if the file does not exist.</returns> | |
| <remarks> | |
| This method should be accurate for regular files and symlinks, but can report incorrect data | |
| if the file's content was modified by writing to it through a different link, unless | |
| MSBUILDALWAYSCHECKCONTENTTIMESTAMP=1. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.OpenFileThroughSymlinks(System.String)"> | |
| <summary> | |
| Get the SafeFileHandle for a file, while skipping reparse points (going directly to target file). | |
| </summary> | |
| <param name="fullPath">Full path to the file in the filesystem</param> | |
| <returns>the SafeFileHandle for a file (target file in case of symlinks)</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetContentLastWriteFileUtcTime(System.String)"> | |
| <summary> | |
| Get the last write time of the content pointed to by a file path. | |
| </summary> | |
| <param name="fullPath">Full path to the file in the filesystem</param> | |
| <returns>The last write time of the file, or DateTime.MinValue if the file does not exist.</returns> | |
| <remarks> | |
| This is the most accurate timestamp-extraction mechanism, but it is too slow to use all the time. | |
| See https://github.com/dotnet/msbuild/issues/2052. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.HResultSucceeded(System.Int32)"> | |
| <summary> | |
| Did the HRESULT succeed | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.HResultFailed(System.Int32)"> | |
| <summary> | |
| Did the HRESULT Fail | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.ThrowExceptionForErrorCode(System.Int32)"> | |
| <summary> | |
| Given an error code, converts it to an HRESULT and throws the appropriate exception. | |
| </summary> | |
| <param name="errorCode"></param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.KillTree(System.Int32)"> | |
| <summary> | |
| Kills the specified process by id and all of its children recursively. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetParentProcessId(System.Int32)"> | |
| <summary> | |
| Returns the parent process id for the specified process. | |
| Returns zero if it cannot be gotten for some reason. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetChildProcessIds(System.Int32,System.DateTime)"> | |
| <summary> | |
| Returns an array of all the immediate child processes by id. | |
| NOTE: The IntPtr in the tuple is the handle of the child process. CloseHandle MUST be called on this. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetCurrentDirectory"> | |
| <summary> | |
| Internal, optimized GetCurrentDirectory implementation that simply delegates to the native method | |
| </summary> | |
| <returns></returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.AreStringsEqual(System.Char*,System.Int32,System.String)"> | |
| <summary> | |
| Compare an unsafe char buffer with a <see cref="T:System.String"/> to see if their contents are identical. | |
| </summary> | |
| <param name="buffer">The beginning of the char buffer.</param> | |
| <param name="len">The length of the buffer.</param> | |
| <param name="s">The string.</param> | |
| <returns>True only if the contents of <paramref name="s"/> and the first <paramref name="len"/> characters in <paramref name="buffer"/> are identical.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetOEMCP"> | |
| <summary> | |
| Gets the current OEM code page which is used by console apps | |
| (as opposed to the Windows/ANSI code page) | |
| Basically for each ANSI code page (set in Regional settings) there's a corresponding OEM code page | |
| that needs to be used for instance when writing to batch files | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.GetModuleFileName(System.Runtime.InteropServices.HandleRef,System.Char[],System.Int32)"> | |
| <summary> | |
| Gets the fully qualified filename of the currently executing .exe. | |
| </summary> | |
| <param name="hModule"><see cref="T:System.Runtime.InteropServices.HandleRef"/> of the module for which we are finding the file name.</param> | |
| <param name="buffer">The character buffer used to return the file name.</param> | |
| <param name="length">The length of the buffer.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.NativeMethods.CoWaitForMultipleHandles(Microsoft.Build.Framework.NativeMethods.COWAIT_FLAGS,System.Int32,System.Int32,System.IntPtr[],System.Int32@)"> | |
| <summary> | |
| CoWaitForMultipleHandles allows us to wait in an STA apartment and still service RPC requests from other threads. | |
| VS needs this in order to allow the in-proc compilers to properly initialize, since they will make calls from the | |
| build thread which the main thread (blocked on BuildSubmission.Execute) must service. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.OutputAttribute"> | |
| <summary> | |
| This attribute is used by task writers to designate certain task parameters as "outputs". The build engine will only allow | |
| task parameters (i.e. the task class' .NET properties) that are marked with this attribute to output data from a task. Project | |
| authors can only use parameters marked with this attribute in a task's <Output> tag. All task parameters, including those | |
| marked with this attribute, may be treated as inputs to a task by the build engine. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.OutputAttribute.#ctor"> | |
| <summary> | |
| Default constructor. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Profiler.EvaluationIdProvider"> | |
| <summary> | |
| Assigns unique evaluation ids. Thread safe. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationIdProvider.GetNextId"> | |
| <summary> | |
| Returns a unique evaluation id | |
| </summary> | |
| <remarks> | |
| The id is guaranteed to be unique across all running processes. | |
| Additionally, it is monotonically increasing for callers on the same process id | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Profiler.EvaluationPass"> | |
| <summary> | |
| Evaluation main phases used by the profiler | |
| </summary> | |
| <remarks> | |
| Order matters since the profiler pretty printer orders profiled items from top to bottom using | |
| the pass they belong to | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationPass.TotalEvaluation"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationPass.TotalGlobbing"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationPass.InitialProperties"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationPass.Properties"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationPass.ItemDefinitionGroups"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationPass.Items"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationPass.LazyItems"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationPass.UsingTasks"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationPass.Targets"> | |
| <nodoc/> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Profiler.EvaluationLocationKind"> | |
| <summary> | |
| The kind of the evaluated location being tracked | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationLocationKind.Element"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationLocationKind.Condition"> | |
| <nodoc/> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationLocationKind.Glob"> | |
| <nodoc/> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Profiler.EvaluationLocation"> | |
| <summary> | |
| Represents a location for different evaluation elements tracked by the EvaluationProfiler. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Profiler.EvaluationLocation.PassDefaultDescription"> | |
| <summary> | |
| Default descriptions for locations that are used in case a description is not provided | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.Id"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.ParentId"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.EvaluationPass"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.EvaluationPassDescription"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.File"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.Line"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.ElementName"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.ElementDescription"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.Kind"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.IsEvaluationPass"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.CreateLocationForCondition(System.Nullable{System.Int64},Microsoft.Build.Framework.Profiler.EvaluationPass,System.String,System.String,System.Nullable{System.Int32},System.String)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.CreateLocationForProject(System.Nullable{System.Int64},Microsoft.Build.Framework.Profiler.EvaluationPass,System.String,System.String,System.Nullable{System.Int32},Microsoft.Build.Framework.IProjectElement)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.CreateLocationForGlob(System.Nullable{System.Int64},Microsoft.Build.Framework.Profiler.EvaluationPass,System.String,System.String,System.Nullable{System.Int32},System.String)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.CreateLocationForAggregatedGlob"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.#ctor(System.Int64,System.Nullable{System.Int64},Microsoft.Build.Framework.Profiler.EvaluationPass,System.String,System.String,System.Nullable{System.Int32},System.String,System.String,Microsoft.Build.Framework.Profiler.EvaluationLocationKind)"> | |
| <summary> | |
| Constructs a generic evaluation location | |
| </summary> | |
| <remarks> | |
| Used by serialization/deserialization purposes | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.#ctor(System.Nullable{System.Int64},Microsoft.Build.Framework.Profiler.EvaluationPass,System.String,System.String,System.Nullable{System.Int32},System.String,System.String,Microsoft.Build.Framework.Profiler.EvaluationLocationKind)"> | |
| <summary> | |
| Constructs a generic evaluation location based on a (possibly null) parent Id. | |
| </summary> | |
| <remarks> | |
| A unique Id gets assigned automatically | |
| Used by serialization/deserialization purposes | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.#ctor(Microsoft.Build.Framework.Profiler.EvaluationPass,System.String,System.String,System.Nullable{System.Int32},System.String,System.String,Microsoft.Build.Framework.Profiler.EvaluationLocationKind)"> | |
| <summary> | |
| Constructs a generic evaluation location with no parent. | |
| </summary> | |
| <remarks> | |
| A unique Id gets assigned automatically | |
| Used by serialization/deserialization purposes | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.EvaluationLocation.EmptyLocation"> | |
| <summary> | |
| An empty location, used as the starting instance. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.WithEvaluationPass(Microsoft.Build.Framework.Profiler.EvaluationPass,System.String)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.WithParentId(System.Nullable{System.Int64})"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.WithFile(System.String)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.WithFileLineAndElement(System.String,System.Nullable{System.Int32},Microsoft.Build.Framework.IProjectElement)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.WithFileLineAndCondition(System.String,System.Nullable{System.Int32},System.String)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.WithGlob(System.String)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.Equals(System.Object)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.ToString"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.EvaluationLocation.GetHashCode"> | |
| <nodoc/> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Profiler.ProfilerResult"> | |
| <summary> | |
| Result of profiling an evaluation | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.ProfilerResult.ProfiledLocations"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.ProfilerResult.#ctor(System.Collections.Generic.IDictionary{Microsoft.Build.Framework.Profiler.EvaluationLocation,Microsoft.Build.Framework.Profiler.ProfiledLocation})"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.ProfilerResult.Equals(System.Object)"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.ProfilerResult.GetHashCode"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Profiler.ProfiledLocation"> | |
| <summary> | |
| Result of timing the evaluation of a given element at a given location | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.ProfiledLocation.InclusiveTime"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.ProfiledLocation.ExclusiveTime"> | |
| <nodoc/> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Profiler.ProfiledLocation.NumberOfHits"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.ProfiledLocation.#ctor(System.TimeSpan,System.TimeSpan,System.Int32)"> | |
| <nodoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.ProfiledLocation.Equals(System.Object)"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.ProfiledLocation.GetHashCode"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Profiler.ProfiledLocation.ToString"> | |
| <inheritdoc/> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs"> | |
| <summary> | |
| Arguments for the project evaluation finished event. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.#ctor"> | |
| <summary> | |
| Initializes a new instance of the ProjectEvaluationFinishedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.#ctor(System.String,System.Object[])"> | |
| <summary> | |
| Initializes a new instance of the ProjectEvaluationFinishedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.ProjectFile"> | |
| <summary> | |
| Gets or sets the full path of the project that started evaluation. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.GlobalProperties"> | |
| <summary> | |
| Global properties used during this evaluation. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.Properties"> | |
| <summary> | |
| Final set of properties produced by this evaluation. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.Items"> | |
| <summary> | |
| Final set of items produced by this evaluation. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectEvaluationFinishedEventArgs.ProfilerResult"> | |
| <summary> | |
| The result of profiling a project. | |
| </summary> | |
| <remarks> | |
| Null if profiling is not turned on | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ProjectEvaluationStartedEventArgs"> | |
| <summary> | |
| Arguments for the project evaluation started event. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectEvaluationStartedEventArgs.#ctor"> | |
| <summary> | |
| Initializes a new instance of the ProjectEvaluationStartedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectEvaluationStartedEventArgs.#ctor(System.String,System.Object[])"> | |
| <summary> | |
| Initializes a new instance of the ProjectEvaluationStartedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectEvaluationStartedEventArgs.ProjectFile"> | |
| <summary> | |
| Gets or sets the full path of the project that started evaluation. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ProjectFinishedEventArgs"> | |
| <summary> | |
| Arguments for project finished events | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectFinishedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectFinishedEventArgs.#ctor(System.String,System.String,System.String,System.Boolean)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">name of the project</param> | |
| <param name="succeeded">true indicates project built successfully</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectFinishedEventArgs.#ctor(System.String,System.String,System.String,System.Boolean,System.DateTime)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". This constructor allows the timestamp to be set as well | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">name of the project</param> | |
| <param name="succeeded">true indicates project built successfully</param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectFinishedEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectFinishedEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectFinishedEventArgs.ProjectFile"> | |
| <summary> | |
| Project name | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectFinishedEventArgs.Succeeded"> | |
| <summary> | |
| True if project built successfully, false otherwise | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ProjectImportedEventArgs"> | |
| <summary> | |
| Arguments for the project imported event. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectImportedEventArgs.#ctor"> | |
| <summary> | |
| Initializes a new instance of the ProjectImportedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectImportedEventArgs.#ctor(System.Int32,System.Int32,System.String,System.Object[])"> | |
| <summary> | |
| Initializes a new instance of the ProjectImportedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectImportedEventArgs.UnexpandedProject"> | |
| <summary> | |
| Gets or sets the original value of the Project attribute. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectImportedEventArgs.ImportedProjectFile"> | |
| <summary> | |
| Gets or sets the full path to the project file that was imported. Will be <code>null</code> | |
| if the import statement was a glob and no files matched, or the condition (if any) evaluated | |
| to false. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectImportedEventArgs.ImportIgnored"> | |
| <summary> | |
| Gets or sets if this import was ignored. Ignoring imports is controlled by | |
| <code>ProjectLoadSettings</code>. This is only set when an import would have been included | |
| but was ignored to due being invalid. This does not include when a globbed import returned | |
| no matches, or a conditioned import that evaluated to false. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ProjectStartedEventArgs"> | |
| <summary> | |
| Arguments for project started events | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ProjectStartedEventArgs.InvalidProjectId"> | |
| <summary> | |
| Indicates an invalid project identifier. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Collections.IEnumerable,System.Collections.IEnumerable)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">project name</param> | |
| <param name="targetNames">targets we are going to build (empty indicates default targets)</param> | |
| <param name="properties">list of properties</param> | |
| <param name="items">list of items</param> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="projectId">project id</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">project name</param> | |
| <param name="targetNames">targets we are going to build (empty indicates default targets)</param> | |
| <param name="properties">list of properties</param> | |
| <param name="items">list of items</param> | |
| <param name="parentBuildEventContext">event context info for the parent project</param> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="projectId">project id</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">project name</param> | |
| <param name="targetNames">targets we are going to build (empty indicates default targets)</param> | |
| <param name="properties">list of properties</param> | |
| <param name="items">list of items</param> | |
| <param name="parentBuildEventContext">event context info for the parent project</param> | |
| <param name="globalProperties">An <see cref="T:System.Collections.Generic.IDictionary`2"/> containing global properties.</param> | |
| <param name="toolsVersion">The tools version.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.Collections.IEnumerable,System.Collections.IEnumerable,System.DateTime)"> | |
| <summary> | |
| This constructor allows event data to be initialized. Also the timestamp can be set | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">project name</param> | |
| <param name="targetNames">targets we are going to build (empty indicates default targets)</param> | |
| <param name="properties">list of properties</param> | |
| <param name="items">list of items</param> | |
| <param name="eventTimestamp">The <see cref="T:System.DateTime"/> of the event.</param> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="projectId">project id</param> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">project name</param> | |
| <param name="targetNames">targets we are going to build (empty indicates default targets)</param> | |
| <param name="properties">list of properties</param> | |
| <param name="items">list of items</param> | |
| <param name="parentBuildEventContext">event context info for the parent project</param> | |
| <param name="eventTimestamp">The <see cref="T:System.DateTime"/> of the event.</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.ProjectId"> | |
| <summary> | |
| Gets the identifier of the project. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.ParentProjectBuildEventContext"> | |
| <summary> | |
| Event context information, where the event was fired from in terms of the build location | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ProjectStartedEventArgs.projectFile"> | |
| <summary> | |
| The name of the project file | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.ProjectFile"> | |
| <summary> | |
| Project name | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ProjectStartedEventArgs.targetNames"> | |
| <summary> | |
| Targets that we will build in the project | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.TargetNames"> | |
| <summary> | |
| Targets that we will build in the project | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ProjectStartedEventArgs.globalProperties"> | |
| <summary> | |
| Gets the set of global properties used to evaluate this project. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.GlobalProperties"> | |
| <summary> | |
| Gets the set of global properties used to evaluate this project. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.ToolsVersion"> | |
| <summary> | |
| Gets the tools version used to evaluate this project. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.Properties"> | |
| <summary> | |
| List of properties in this project. This is a live, read-only list. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ProjectStartedEventArgs.Items"> | |
| <summary> | |
| List of items in this project. This is a live, read-only list. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ProjectStartedEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.PropertyInitialValueSetEventArgs"> | |
| <summary> | |
| The argument for a property initial value set event. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.PropertyInitialValueSetEventArgs.#ctor"> | |
| <summary> | |
| Creates an instance of the <see cref="T:Microsoft.Build.Framework.PropertyInitialValueSetEventArgs"/> class. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.PropertyInitialValueSetEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| Creates an instance of the <see cref="T:Microsoft.Build.Framework.PropertyInitialValueSetEventArgs"/> class. | |
| </summary> | |
| <param name="propertyName">The name of the property.</param> | |
| <param name="propertyValue">The value of the property.</param> | |
| <param name="propertySource">The source of the property.</param> | |
| <param name="message">The message of the property.</param> | |
| <param name="helpKeyword">The help keyword.</param> | |
| <param name="senderName">The sender name of the event.</param> | |
| <param name="importance">The importance of the message.</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.PropertyInitialValueSetEventArgs.PropertyName"> | |
| <summary> | |
| The name of the property. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.PropertyInitialValueSetEventArgs.PropertyValue"> | |
| <summary> | |
| The value of the property. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.PropertyInitialValueSetEventArgs.PropertySource"> | |
| <summary> | |
| The source of the property. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.PropertyReassignmentEventArgs"> | |
| <summary> | |
| The argument for a property reassignment event. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.PropertyReassignmentEventArgs.#ctor"> | |
| <summary> | |
| Creates an instance of the PropertyReassignmentEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.PropertyReassignmentEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| Creates an instance of the PropertyReassignmentEventArgs class. | |
| </summary> | |
| <param name="propertyName">The name of the property whose value was reassigned.</param> | |
| <param name="previousValue">The previous value of the reassigned property.</param> | |
| <param name="newValue">The new value of the reassigned property.</param> | |
| <param name="location">The location of the reassignment.</param> | |
| <param name="message">The message of the reassignment event.</param> | |
| <param name="helpKeyword">The help keyword of the reassignment.</param> | |
| <param name="senderName">The sender name of the reassignment event.</param> | |
| <param name="importance">The importance of the message.</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.PropertyReassignmentEventArgs.PropertyName"> | |
| <summary> | |
| The name of the property whose value was reassigned. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.PropertyReassignmentEventArgs.PreviousValue"> | |
| <summary> | |
| The previous value of the reassigned property. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.PropertyReassignmentEventArgs.NewValue"> | |
| <summary> | |
| The new value of the reassigned property. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.PropertyReassignmentEventArgs.Location"> | |
| <summary> | |
| The location of the reassignment. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.RequiredAttribute"> | |
| <summary> | |
| This class defines the attribute that a task writer can apply to a task's property to declare the property to be a | |
| required property. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.RequiredAttribute.#ctor"> | |
| <summary> | |
| Default constructor. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.RequiredRuntimeAttribute"> | |
| <summary> | |
| When marked with the RequiredRuntimeAttribute, a task indicates that it has stricter | |
| runtime requirements than a regular task - this tells MSBuild that it will need to potentially | |
| launch a separate process for that task if the current runtime does not match the version requirement. | |
| This attribute is currently non-functional since there is only one version of the CLR that is | |
| capable of running MSBuild v2.0 or v3.5 - the runtime v2.0 | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.RequiredRuntimeAttribute.#ctor(System.String)"> | |
| <summary> | |
| Constructor taking a version, such as "v2.0". | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.RequiredRuntimeAttribute.RuntimeVersion"> | |
| <summary> | |
| Returns the runtime version the attribute was constructed with, | |
| e.g., "v2.0" | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ResponseFileUsedEventArgs"> | |
| <summary> | |
| Arguments for the response file used event | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ResponseFileUsedEventArgs.#ctor(System.String)"> | |
| <summary> | |
| Initialize a new instance of the ResponseFileUsedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ReuseableStringBuilder"> | |
| <summary> | |
| A StringBuilder lookalike that reuses its internal storage. | |
| </summary> | |
| <remarks> | |
| This class is being deprecated in favor of SpanBasedStringBuilder in StringTools. Avoid adding more uses. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ReuseableStringBuilder._borrowedBuilder"> | |
| <summary> | |
| Captured string builder. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ReuseableStringBuilder._borrowedWithCapacity"> | |
| <summary> | |
| Capacity of borrowed string builder at the time of borrowing. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ReuseableStringBuilder._capacity"> | |
| <summary> | |
| Capacity to initialize the builder with. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.#ctor(System.Int32)"> | |
| <summary> | |
| Create a new builder, under the covers wrapping a reused one. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.ReuseableStringBuilder.Length"> | |
| <summary> | |
| The length of the target. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.ToString"> | |
| <summary> | |
| Convert to a string. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.Dispose"> | |
| <summary> | |
| Dispose, indicating you are done with this builder. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.Append(System.Char)"> | |
| <summary> | |
| Append a character. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.Append(System.String)"> | |
| <summary> | |
| Append a string. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.Append(System.String,System.Int32,System.Int32)"> | |
| <summary> | |
| Append a substring. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.AppendFormat(System.Globalization.CultureInfo,System.String,System.Object[])"> | |
| <inheritdoc cref="M:System.Text.StringBuilder.AppendFormat(System.IFormatProvider,System.String,System.Object[])"/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.AppendLine"> | |
| <inheritdoc cref="M:System.Text.StringBuilder.AppendLine"/> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.Remove(System.Int32,System.Int32)"> | |
| <summary> | |
| Remove a substring. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.LazyPrepare"> | |
| <summary> | |
| Grab a backing builder if necessary. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.ReuseableStringBuilder.ReuseableStringBuilderFactory"> | |
| <summary> | |
| A utility class that mediates access to a shared string builder. | |
| </summary> | |
| <remarks> | |
| If this shared builder is highly contended, this class could add | |
| a second one and try both in turn. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ReuseableStringBuilder.ReuseableStringBuilderFactory.MaxBuilderSizeBytes"> | |
| <summary> | |
| Made up limit beyond which we won't share the builder | |
| because we could otherwise hold a huge builder indefinitely. | |
| This was picked empirically to save at least 95% of allocated data size. | |
| This constant has to be exactly 2^n (power of 2) where n = 4 ... 32 as GC is optimized to work with such block sizes. | |
| Same approach is used in ArrayPool or RecyclableMemoryStream so having same uniform allocation sizes will | |
| reduce likelihood of heaps fragmentation. | |
| </summary> | |
| <remarks> | |
| In order to collect and analyze ETW ReusableStringBuilderFactory events developer could follow these steps: | |
| - With compiled as Debug capture events by perfview; example: "perfview collect /NoGui /OnlyProviders=*Microsoft-Build" | |
| - Open Events view and filter for ReusableStringBuilderFactory and pick ReusableStringBuilderFactory/Stop | |
| - Display columns: returning length, type | |
| - Set MaxRet limit to 1_000_000 | |
| - Right click and Open View in Excel | |
| - Use Excel data analytic tools to extract required data from it. I recommend to use | |
| Pivot Table/Chart with | |
| filter: type=[return-se,discarder]; | |
| rows: returningLength grouped (right click and Group... into sufficient size bins) | |
| value: sum of returningLength | |
| </remarks> | |
| <remarks> | |
| This constant might looks huge, but rather than lowering this constant, | |
| we shall focus on eliminating code which requires creating such huge strings. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.ReuseableStringBuilder.ReuseableStringBuilderFactory.s_sharedBuilder"> | |
| <summary> | |
| The shared builder. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.ReuseableStringBuilderFactory.Get(System.Int32)"> | |
| <summary> | |
| Obtains a string builder which may or may not already | |
| have been used. | |
| Never returns null. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.ReuseableStringBuilder.ReuseableStringBuilderFactory.Release(Microsoft.Build.Framework.ReuseableStringBuilder)"> | |
| <summary> | |
| Returns the shared builder for the next caller to use. | |
| ** CALLERS, DO NOT USE THE BUILDER AFTER RELEASING IT HERE! ** | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.RunInMTAAttribute"> | |
| <summary> | |
| This attribute is used to mark a task class as explicitly not being required to run in the STA for COM. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.RunInMTAAttribute.#ctor"> | |
| <summary> | |
| Default constructor. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.RunInSTAAttribute"> | |
| <summary> | |
| This attribute is used to mark a task class as being required to run in a Single Threaded Apartment for COM. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.RunInSTAAttribute.#ctor"> | |
| <summary> | |
| Default constructor. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.SdkLogger"> | |
| <summary> | |
| An abstract interface class to providing real-time logging and status while resolving | |
| an SDK. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkLogger.LogMessage(System.String,Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| Log a build message to MSBuild. | |
| </summary> | |
| <param name="message">Message string.</param> | |
| <param name="messageImportance">Optional message importances. Default to low.</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.SdkReference"> | |
| <summary> | |
| Represents a software development kit (SDK) that is referenced in a <Project /> or <Import /> element. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkReference.#ctor(System.String,System.String,System.String)"> | |
| <summary> | |
| Initializes a new instance of the SdkReference class. | |
| </summary> | |
| <param name="name">The name of the SDK.</param> | |
| <param name="version">The version of the SDK.</param> | |
| <param name="minimumVersion">Minimum SDK version required by the project.</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkReference.Name"> | |
| <summary> | |
| Gets the name of the SDK. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkReference.Version"> | |
| <summary> | |
| Gets the version of the SDK. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkReference.MinimumVersion"> | |
| <summary> | |
| Gets the minimum version required. This value is specified by the project to indicate the minimum version of the | |
| SDK that is required in order to build. This is useful in order to produce an error message if a name match can | |
| be found but no acceptable version could be resolved. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkReference.Equals(Microsoft.Build.Framework.SdkReference)"> | |
| <summary>Indicates whether the current object is equal to another object of the same type.</summary> | |
| <param name="other">An object to compare with this object.</param> | |
| <returns> | |
| <see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />. | |
| </returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkReference.TryParse(System.String,Microsoft.Build.Framework.SdkReference@)"> | |
| <summary> | |
| Attempts to parse the specified string as a <see cref="T:Microsoft.Build.Framework.SdkReference" />. The expected format is: | |
| SDK, SDK/Version, or SDK/min=MinimumVersion | |
| Values are not required to specify a version or MinimumVersion. | |
| </summary> | |
| <param name="sdk">An SDK name and version to parse in the format "SDK/Version,min=MinimumVersion".</param> | |
| <param name="sdkReference">A parsed <see cref="T:Microsoft.Build.Framework.SdkReference" /> if the specified value is a valid SDK name.</param> | |
| <returns><code>true</code> if the SDK name was successfully parsed, otherwise <code>false</code>.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkReference.Equals(System.Object)"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkReference.GetHashCode"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkReference.ToString"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.SdkResolver"> | |
| <summary> | |
| An abstract interface for classes that can resolve a Software Development Kit (SDK). | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResolver.Name"> | |
| <summary> | |
| Gets the name of the <see cref="T:Microsoft.Build.Framework.SdkResolver"/> to be displayed in build output log. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResolver.Priority"> | |
| <summary> | |
| Gets the self-described resolution priority order. MSBuild will sort resolvers | |
| by this value. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkResolver.Resolve(Microsoft.Build.Framework.SdkReference,Microsoft.Build.Framework.SdkResolverContext,Microsoft.Build.Framework.SdkResultFactory)"> | |
| <summary> | |
| Resolves the specified SDK reference. | |
| </summary> | |
| <param name="sdkReference">A <see cref="T:Microsoft.Build.Framework.SdkReference" /> containing the referenced SDKs be resolved.</param> | |
| <param name="resolverContext">Context for resolving the SDK.</param> | |
| <param name="factory">Factory class to create an <see cref="T:Microsoft.Build.Framework.SdkResult" /></param> | |
| <returns> | |
| An <see cref="T:Microsoft.Build.Framework.SdkResult" /> containing the resolved SDKs or associated error / reason | |
| the SDK could not be resolved. Return <see langword="null"/> if the resolver is not | |
| applicable for a particular <see cref="T:Microsoft.Build.Framework.SdkReference"/>. | |
| </returns> | |
| <remarks> | |
| Note: You must use <see cref="T:Microsoft.Build.Framework.SdkResultFactory"/> to return a result. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.SdkResolverContext"> | |
| <summary> | |
| Context used by an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> to resolve an SDK. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResolverContext.Interactive"> | |
| <summary> | |
| Gets a value indicating if the resolver is allowed to be interactive. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResolverContext.IsRunningInVisualStudio"> | |
| <summary> | |
| Gets a value indicating if the resolver is running in Visual Studio. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResolverContext.Logger"> | |
| <summary> | |
| Logger to log real-time messages back to MSBuild. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResolverContext.ProjectFilePath"> | |
| <summary> | |
| Path to the project file being built. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResolverContext.SolutionFilePath"> | |
| <summary> | |
| Path to the solution file being built, if known. May be null. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResolverContext.MSBuildVersion"> | |
| <summary> | |
| Version of MSBuild currently running. | |
| </summary> | |
| <remarks> | |
| <format type="text/markdown"><![CDATA[ | |
| ## Remarks | |
| File version is informational and not equal to the assembly version. | |
| ]]></format> | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResolverContext.State"> | |
| <summary> | |
| Gets or sets any custom state for current build. This allows resolvers to maintain state between resolutions. | |
| This property is not thread-safe. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.SdkResult"> | |
| <summary> | |
| An abstract interface class to indicate SDK resolver success or failure. | |
| </summary> | |
| <remarks> | |
| <format type="text/markdown"><![CDATA[ | |
| ## Remarks | |
| > [!NOTE] | |
| > Use <xref:Microsoft.Build.Framework.SdkResultFactory> to create instances of this class. Do not inherit from this class. | |
| ]]></format> | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResult.Success"> | |
| <summary> | |
| Indicates the resolution was successful. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResult.Path"> | |
| <summary> | |
| Resolved path to the SDK. | |
| Null if <see cref="P:Microsoft.Build.Framework.SdkResult.Success"/> == false | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResult.Version"> | |
| <summary> | |
| Resolved version of the SDK. | |
| Can be null or empty if the resolver did not provide a version (e.g. a path based resolver) | |
| Null if <see cref="P:Microsoft.Build.Framework.SdkResult.Success"/> == false | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResult.AdditionalPaths"> | |
| <summary> | |
| Additional resolved SDK paths beyond the one specified in <see cref="P:Microsoft.Build.Framework.SdkResult.Path"/> | |
| </summary> | |
| <remarks> | |
| This allows an SDK resolver to return multiple SDK paths, which will all be imported. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResult.PropertiesToAdd"> | |
| <summary> | |
| Properties that should be added to the evaluation. This allows an SDK resolver to provide information to the build | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResult.ItemsToAdd"> | |
| <summary> | |
| Items that should be added to the evaluation. This allows an SDK resolver to provide information to the build | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.SdkResult.SdkReference"> | |
| <summary> | |
| The Sdk reference | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.SdkResultFactory"> | |
| <summary> | |
| An abstract interface class provided to <see cref="T:Microsoft.Build.Framework.SdkResolver" /> to create an | |
| <see cref="T:Microsoft.Build.Framework.SdkResult" /> object indicating success / failure. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkResultFactory.IndicateSuccess(System.String,System.String,System.Collections.Generic.IEnumerable{System.String})"> | |
| <summary> | |
| Create an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> object indicating success resolving the SDK. | |
| </summary> | |
| <param name="path">Path to the SDK.</param> | |
| <param name="version">Version of the SDK that was resolved.</param> | |
| <param name="warnings">Optional warnings to display during resolution.</param> | |
| <returns></returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkResultFactory.IndicateSuccess(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,Microsoft.Build.Framework.SdkResultItem},System.Collections.Generic.IEnumerable{System.String})"> | |
| <summary> | |
| Create an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> object indicating success resolving the SDK. | |
| </summary> | |
| <param name="path">Path to the SDK.</param> | |
| <param name="version">Version of the SDK that was resolved.</param> | |
| <param name="propertiesToAdd">Properties to set in the evaluation</param> | |
| <param name="itemsToAdd">Items to add to the evaluation</param> | |
| <param name="warnings">Optional warnings to display during resolution.</param> | |
| <returns></returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkResultFactory.IndicateSuccess(System.Collections.Generic.IEnumerable{System.String},System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,Microsoft.Build.Framework.SdkResultItem},System.Collections.Generic.IEnumerable{System.String})"> | |
| <summary> | |
| Create an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> object indicating success. | |
| </summary> | |
| <remarks> | |
| This overload allows any number (zero, one, or many) of SDK paths to be returned. This means a "successful" result | |
| may not resolve to any SDKs. The resolver can also supply properties or items to communicate information to the build. This | |
| can allow resolvers to report SDKs that could not be resolved without hard-failing the evaluation, which can allow other | |
| components to take more appropriate action (for example installing optional workloads or downloading NuGet SDKs). | |
| </remarks> | |
| <param name="paths">SDK paths which should be imported</param> | |
| <param name="version">SDK version which should be imported</param> | |
| <param name="propertiesToAdd">Properties to set in the evaluation</param> | |
| <param name="itemsToAdd">Items to add to the evaluation</param> | |
| <param name="warnings">Optional warnings to display during resolution.</param> | |
| <returns></returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkResultFactory.IndicateFailure(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})"> | |
| <summary> | |
| Create an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> object indicating failure resolving the SDK. | |
| </summary> | |
| <param name="errors"> | |
| Errors / reasons the SDK could not be resolved. Will be logged as a | |
| build error if no other SdkResolvers were able to indicate success. | |
| </param> | |
| <param name="warnings"></param> | |
| <returns></returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.SdkResultItem"> | |
| <summary> | |
| The value of an item and any associated metadata to be added by an SDK resolver. See <see cref="P:Microsoft.Build.Framework.SdkResult.ItemsToAdd"/> | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.SdkResultItem.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> | |
| <summary> | |
| Creates an <see cref="T:Microsoft.Build.Framework.SdkResultItem"/> | |
| </summary> | |
| <param name="itemSpec">The value (itemspec) for the item</param> | |
| <param name="metadata">A dictionary of item metadata. This should be created with <see cref="P:System.StringComparer.OrdinalIgnoreCase"/> for the comparer.</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.StringBuilderCache"> | |
| <summary> | |
| A cached reusable instance of StringBuilder. | |
| </summary> | |
| <remarks> | |
| An optimization that reduces the number of instances of <see cref="T:System.Text.StringBuilder"/> constructed and collected. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.StringBuilderCache.Acquire(System.Int32)"> | |
| <summary> | |
| Get a <see cref="T:System.Text.StringBuilder"/> of at least the specified capacity. | |
| </summary> | |
| <param name="capacity">The suggested starting size of this instance.</param> | |
| <returns>A <see cref="T:System.Text.StringBuilder"/> that may or may not be reused.</returns> | |
| <remarks> | |
| It can be called any number of times; if a <see cref="T:System.Text.StringBuilder"/> is in the cache then | |
| it will be returned and the cache emptied. Subsequent calls will return a new <see cref="T:System.Text.StringBuilder"/>. | |
| <para>The <see cref="T:System.Text.StringBuilder"/> instance is cached in Thread Local Storage and so there is one per thread.</para> | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.StringBuilderCache.Release(System.Text.StringBuilder)"> | |
| <summary> | |
| Place the specified builder in the cache if it is not too big. Unbalanced Releases are acceptable. | |
| The StringBuilder should not be used after it has | |
| been released. | |
| Unbalanced Releases are perfectly acceptable.It | |
| will merely cause the runtime to create a new | |
| StringBuilder next time Acquire is called. | |
| </summary> | |
| <param name="sb">The <see cref="T:System.Text.StringBuilder"/> to cache. Likely returned from <see cref="M:Microsoft.Build.Framework.StringBuilderCache.Acquire(System.Int32)"/>.</param> | |
| <remarks> | |
| The StringBuilder should not be used after it has been released. | |
| <para> | |
| Unbalanced Releases are perfectly acceptable.It | |
| will merely cause the runtime to create a new | |
| StringBuilder next time Acquire is called. | |
| </para> | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.StringBuilderCache.GetStringAndRelease(System.Text.StringBuilder)"> | |
| <summary> | |
| Get a string and return its builder to the cache. | |
| </summary> | |
| <param name="sb">Builder to cache (if it's not too big).</param> | |
| <returns>The <see langword="string"/> equivalent to <paramref name="sb"/>'s contents.</returns> | |
| <remarks> | |
| Convenience method equivalent to calling <see cref="M:System.Text.StringBuilder.ToString"/> followed by <see cref="M:Microsoft.Build.Framework.StringBuilderCache.Release(System.Text.StringBuilder)"/>. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TargetBuiltReason"> | |
| <summary> | |
| The reason that a target was built by its parent target. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TargetBuiltReason.None"> | |
| <summary> | |
| This wasn't built on because of a parent. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TargetBuiltReason.BeforeTargets"> | |
| <summary> | |
| The target was part of the parent's BeforeTargets list. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TargetBuiltReason.DependsOn"> | |
| <summary> | |
| The target was part of the parent's DependsOn list. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TargetBuiltReason.AfterTargets"> | |
| <summary> | |
| The target was part of the parent's AfterTargets list. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TargetFinishedEventArgs"> | |
| <summary> | |
| Arguments for target finished events | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetFinishedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="targetName">target name</param> | |
| <param name="projectFile">project file</param> | |
| <param name="targetFile">file in which the target is defined</param> | |
| <param name="succeeded">true if target built successfully</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Collections.IEnumerable)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="targetName">target name</param> | |
| <param name="projectFile">project file</param> | |
| <param name="targetFile">file in which the target is defined</param> | |
| <param name="succeeded">true if target built successfully</param> | |
| <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> | |
| </member> | |
| <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)"> | |
| <summary> | |
| This constructor allows event data to be initialized including the timestamp when the event was created. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="targetName">target name</param> | |
| <param name="projectFile">project file</param> | |
| <param name="targetFile">file in which the target is defined</param> | |
| <param name="succeeded">true if target built successfully</param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| <param name="targetOutputs">An <see cref="T:System.Collections.IEnumerable"/> containing the outputs of the target.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetFinishedEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetFinishedEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.TargetName"> | |
| <summary> | |
| Target name | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.Succeeded"> | |
| <summary> | |
| True if target built successfully, false otherwise | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.ProjectFile"> | |
| <summary> | |
| Project file associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.TargetFile"> | |
| <summary> | |
| File where this target was declared. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetFinishedEventArgs.TargetOutputs"> | |
| <summary> | |
| Target outputs | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TargetSkipReason"> | |
| <summary> | |
| A reason why a target was skipped. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TargetSkipReason.None"> | |
| <summary> | |
| The target was not skipped or the skip reason was unknown. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TargetSkipReason.PreviouslyBuiltSuccessfully"> | |
| <summary> | |
| The target previously built successfully. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TargetSkipReason.PreviouslyBuiltUnsuccessfully"> | |
| <summary> | |
| The target previously built unsuccessfully. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TargetSkipReason.OutputsUpToDate"> | |
| <summary> | |
| All the target outputs were up-to-date with respect to their inputs. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TargetSkipReason.ConditionWasFalse"> | |
| <summary> | |
| The condition on the target was evaluated as false. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TargetSkippedEventArgs"> | |
| <summary> | |
| Arguments for the target skipped event. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetSkippedEventArgs.#ctor"> | |
| <summary> | |
| Initializes a new instance of the TargetSkippedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetSkippedEventArgs.#ctor(System.String,System.Object[])"> | |
| <summary> | |
| Initializes a new instance of the TargetSkippedEventArgs class. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetSkippedEventArgs.SkipReason"> | |
| <summary> | |
| The reason why the target was skipped. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetSkippedEventArgs.TargetName"> | |
| <summary> | |
| Gets or sets the name of the target being skipped. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetSkippedEventArgs.ParentTarget"> | |
| <summary> | |
| Gets or sets the parent target of the target being skipped. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetSkippedEventArgs.TargetFile"> | |
| <summary> | |
| File where this target was declared. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetSkippedEventArgs.BuildReason"> | |
| <summary> | |
| Why the parent target built this target. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetSkippedEventArgs.OriginallySucceeded"> | |
| <summary> | |
| Whether the target succeeded originally. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetSkippedEventArgs.OriginalBuildEventContext"> | |
| <summary> | |
| <see cref="T:Microsoft.Build.Framework.BuildEventContext"/> describing the original build of the target, or null if not available. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetSkippedEventArgs.Condition"> | |
| <summary> | |
| The condition expression on the target declaration. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetSkippedEventArgs.EvaluatedCondition"> | |
| <summary> | |
| The value of the condition expression as it was evaluated. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TargetStartedEventArgs"> | |
| <summary> | |
| Arguments for target started events | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetStartedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="targetName">target name</param> | |
| <param name="projectFile">project file</param> | |
| <param name="targetFile">file in which the target is defined</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| This constructor allows event data to be initialized including the timestamp when the event was created. | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="targetName">target name</param> | |
| <param name="projectFile">project file</param> | |
| <param name="targetFile">file in which the target is defined</param> | |
| <param name="parentTarget">The part of the target.</param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,Microsoft.Build.Framework.TargetBuiltReason,System.DateTime)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="targetName">target name</param> | |
| <param name="projectFile">project file</param> | |
| <param name="targetFile">file in which the target is defined</param> | |
| <param name="parentTarget">The part of the target.</param> | |
| <param name="buildReason">The reason the parent built this target.</param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetStartedEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TargetStartedEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetStartedEventArgs.TargetName"> | |
| <summary> | |
| target name | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetStartedEventArgs.ParentTarget"> | |
| <summary> | |
| Target which caused this target to build | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetStartedEventArgs.ProjectFile"> | |
| <summary> | |
| Project file associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetStartedEventArgs.TargetFile"> | |
| <summary> | |
| File where this target was declared. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TargetStartedEventArgs.BuildReason"> | |
| <summary> | |
| Why this target was built by its parent. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TaskCommandLineEventArgs"> | |
| <summary> | |
| This class is used by tasks to log their command lines. This class extends | |
| <see cref="T:Microsoft.Build.Framework.BuildMessageEventArgs"/> so that command lines can be logged as | |
| messages. Logging a command line is only relevant for tasks that wrap an | |
| underlying executable/tool, or emulate a shell command. Tasks that have | |
| no command line equivalent should not raise this extended message event. | |
| </summary> | |
| <remarks> | |
| WARNING: marking a type [Serializable] without implementing ISerializable | |
| imposes a serialization contract -- it is a promise to never change the | |
| type's fields i.e. the type is immutable; adding new fields in the next | |
| version of the type without following certain special FX guidelines, can | |
| break both forward and backward compatibility | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskCommandLineEventArgs.#ctor"> | |
| <summary> | |
| Default (family) constructor. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskCommandLineEventArgs.#ctor(System.String,System.String,Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| Creates an instance of this class for the given task command line. | |
| </summary> | |
| <param name="commandLine">The command line used by a task to launch | |
| its underlying tool/executable.</param> | |
| <param name="taskName">The name of the task raising this event.</param> | |
| <param name="importance">Importance of command line -- controls whether | |
| the command line will be displayed by less verbose loggers.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskCommandLineEventArgs.#ctor(System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime)"> | |
| <summary> | |
| Creates an instance of this class for the given task command line. This constructor allows the timestamp to be set | |
| </summary> | |
| <param name="commandLine">The command line used by a task to launch | |
| its underlying tool/executable.</param> | |
| <param name="taskName">The name of the task raising this event.</param> | |
| <param name="importance">Importance of command line -- controls whether | |
| the command line will be displayed by less verbose loggers.</param> | |
| <param name="eventTimestamp">Timestamp when the event was created</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskCommandLineEventArgs.CommandLine"> | |
| <summary> | |
| Gets the task command line associated with this event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskCommandLineEventArgs.TaskName"> | |
| <summary> | |
| Gets the name of the task that raised this event. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TaskFinishedEventArgs"> | |
| <summary> | |
| Arguments for task finished events | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskFinishedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">project file</param> | |
| <param name="taskFile">file in which the task is defined</param> | |
| <param name="taskName">task name</param> | |
| <param name="succeeded">true indicates task succeed</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskFinishedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.DateTime)"> | |
| <summary> | |
| This constructor allows event data to be initialized and the timestamp to be set | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">project file</param> | |
| <param name="taskFile">file in which the task is defined</param> | |
| <param name="taskName">task name</param> | |
| <param name="succeeded">true indicates task succeed</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskFinishedEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskFinishedEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes the Errorevent from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskFinishedEventArgs.TaskName"> | |
| <summary> | |
| Task Name | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskFinishedEventArgs.Succeeded"> | |
| <summary> | |
| True if target built successfully, false otherwise | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskFinishedEventArgs.ProjectFile"> | |
| <summary> | |
| Project file associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskFinishedEventArgs.TaskFile"> | |
| <summary> | |
| MSBuild file where this task was defined. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TaskItemData"> | |
| <summary> | |
| Lightweight specialized implementation of <see cref="T:Microsoft.Build.Framework.ITaskItem"/> only used for deserializing items. | |
| The goal is to minimize overhead when representing deserialized items. | |
| Used by node packet translator and binary logger. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskItemData.#ctor(Microsoft.Build.Framework.ITaskItem)"> | |
| <summary> | |
| Clone the task item and all metadata to create a snapshot | |
| </summary> | |
| <param name="original">An <see cref="T:Microsoft.Build.Framework.ITaskItem"/> to clone</param> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TaskParameterEventArgs"> | |
| <summary> | |
| This class is used by tasks to log their parameters (input, output). | |
| The intrinsic ItemGroupIntrinsicTask to add or remove items also | |
| uses this class. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskParameterEventArgs.#ctor(Microsoft.Build.Framework.TaskParameterMessageKind,System.String,System.Collections.IList,System.Boolean,System.DateTime)"> | |
| <summary> | |
| Creates an instance of this class for the given task parameter. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TaskParameterEventArgs.MessageGetter"> | |
| <summary> | |
| The <see cref="T:Microsoft.Build.Framework.TaskParameterEventArgs"/> type is declared in Microsoft.Build.Framework.dll | |
| which is a declarations assembly. The logic to realize the Message is in Microsoft.Build.dll | |
| which is an implementations assembly. This seems like the easiest way to inject the | |
| implementation for realizing the Message. | |
| </summary> | |
| <remarks> | |
| Note that the current implementation never runs and is provided merely | |
| as a safeguard in case MessageGetter isn't set for some reason. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TaskParameterEventArgs.DictionaryFactory"> | |
| <summary> | |
| Provides a way for Microsoft.Build.dll to provide a more efficient dictionary factory | |
| (using ArrayDictionary`2). Since that is an implementation detail, it is not included | |
| in Microsoft.Build.Framework.dll so we need this extensibility point here. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TaskPropertyInfo"> | |
| <summary> | |
| Class which represents the parameter information from the using task as a strongly typed class. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskPropertyInfo.#ctor(System.String,System.Type,System.Boolean,System.Boolean)"> | |
| <summary> | |
| Encapsulates a list of parameters declared in the UsingTask | |
| </summary> | |
| <param name="name">Name of the parameter</param> | |
| <param name="typeOfParameter">The actual type of the parameter</param> | |
| <param name="output">True if the parameter is both an output and input parameter. False if the parameter is only an input parameter</param> | |
| <param name="required">True if the parameter must be supplied to each invocation of the task.</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.PropertyType"> | |
| <summary> | |
| The type of the property | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.Name"> | |
| <summary> | |
| Name of the property | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.Output"> | |
| <summary> | |
| This task parameter is an output parameter (analogous to [Output] attribute) | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.Required"> | |
| <summary> | |
| This task parameter is required (analogous to the [Required] attribute) | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.Log"> | |
| <summary> | |
| This task parameter should be logged when LogTaskInputs is set. Defaults to true. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskPropertyInfo.LogItemMetadata"> | |
| <summary> | |
| When this task parameter is an item list, determines whether to log item metadata. Defaults to true. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.TaskPropertyInfo.Initialized"> | |
| <summary> | |
| Whether the Log and LogItemMetadata properties have been assigned already. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TaskStartedEventArgs"> | |
| <summary> | |
| Arguments for task started events | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskStartedEventArgs.#ctor"> | |
| <summary> | |
| Default constructor | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">project file</param> | |
| <param name="taskFile">file in which the task is defined</param> | |
| <param name="taskName">task name</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.DateTime)"> | |
| <summary> | |
| This constructor allows event data to be initialized. | |
| Sender is assumed to be "MSBuild". | |
| </summary> | |
| <param name="message">text message</param> | |
| <param name="helpKeyword">help keyword </param> | |
| <param name="projectFile">project file</param> | |
| <param name="taskFile">file in which the task is defined</param> | |
| <param name="taskName">task name</param> | |
| <param name="eventTimestamp">Timestamp when event was created</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskStartedEventArgs.WriteToStream(System.IO.BinaryWriter)"> | |
| <summary> | |
| Serializes to a stream through a binary writer | |
| </summary> | |
| <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.TaskStartedEventArgs.CreateFromStream(System.IO.BinaryReader,System.Int32)"> | |
| <summary> | |
| Deserializes the Errorevent from a stream through a binary reader | |
| </summary> | |
| <param name="reader">Binary reader which is attached to the stream the event will be deserialized from</param> | |
| <param name="version">The version of the runtime the message packet was created from</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskStartedEventArgs.TaskName"> | |
| <summary> | |
| Task name. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskStartedEventArgs.ProjectFile"> | |
| <summary> | |
| Project file associated with event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskStartedEventArgs.TaskFile"> | |
| <summary> | |
| MSBuild file where this task was defined. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskStartedEventArgs.LineNumber"> | |
| <summary> | |
| Line number of the task invocation in the project file | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TaskStartedEventArgs.ColumnNumber"> | |
| <summary> | |
| Column number of the task invocation in the project file | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.TelemetryEventArgs"> | |
| <summary> | |
| Arguments for telemetry events. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TelemetryEventArgs.EventName"> | |
| <summary> | |
| Gets or sets the name of the event. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.TelemetryEventArgs.Properties"> | |
| <summary> | |
| Gets or sets a list of properties associated with the event. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Telemetry.BuildTelemetry"> | |
| <summary> | |
| Telemetry of build. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.StartAt"> | |
| <summary> | |
| Time at which build have started. | |
| </summary> | |
| <remarks> | |
| It is time when build started, not when BuildManager start executing build. | |
| For example in case of MSBuild Server it is time before we connected or launched MSBuild Server. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.InnerStartAt"> | |
| <summary> | |
| Time at which inner build have started. | |
| </summary> | |
| <remarks> | |
| It is time when build internally started, i.e. when BuildManager starts it. | |
| In case of MSBuild Server it is time when Server starts build. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.FinishedAt"> | |
| <summary> | |
| Time at which build have finished. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.Success"> | |
| <summary> | |
| Overall build success. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.Target"> | |
| <summary> | |
| Build Target. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.ServerFallbackReason"> | |
| <summary> | |
| MSBuild server fallback reason. | |
| Either "ServerBusy", "ConnectionError" or null (no fallback). | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.Version"> | |
| <summary> | |
| Version of MSBuild. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.DisplayVersion"> | |
| <summary> | |
| Display version of the Engine suitable for display to a user. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.Project"> | |
| <summary> | |
| Path to project file. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.Host"> | |
| <summary> | |
| Host in which MSBuild build was executed. | |
| For example: "VS", "VSCode", "Azure DevOps", "GitHub Action", "CLI", ... | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.InitialServerState"> | |
| <summary> | |
| State of MSBuild server process before this build. | |
| One of 'cold', 'hot', null (if not run as server) | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.BuildTelemetry.FrameworkName"> | |
| <summary> | |
| Framework name suitable for display to a user. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Telemetry.KnownTelemetry"> | |
| <summary> | |
| Static class to help access and modify known telemetries. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.KnownTelemetry.PartialBuildTelemetry"> | |
| <summary> | |
| Partial Telemetry for build. | |
| This could be optionally initialized with some values from early in call stack, for example in Main method. | |
| After this instance is acquired by a particular build, this is set to null. | |
| Null means there are no prior collected build telemetry data, new clean instance shall be created for particular build. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.KnownTelemetry.LoggingConfigurationTelemetry"> | |
| <summary> | |
| Describes how logging was configured. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.TerminalLogger"> | |
| <summary> | |
| True if terminal logger was used. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.TerminalLoggerUserIntent"> | |
| <summary> | |
| What was user intent: | |
| on | true -> user intent to enable logging | |
| off | false -> user intent to disable logging | |
| auto -> user intent to use logging if terminal allows it | |
| null -> no user intent, using default | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.TerminalLoggerUserIntentSource"> | |
| <summary> | |
| How was user intent signaled: | |
| arg -> from command line argument or rsp file | |
| MSBUILDTERMINALLOGGER -> from environment variable | |
| MSBUILDLIVELOGGER -> from environment variable | |
| null -> no user intent | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.TerminalLoggerDefault"> | |
| <summary> | |
| The default behavior of terminal logger if user intent is not specified: | |
| on | true -> enable logging | |
| off | false -> disable logging | |
| auto -> use logging if terminal allows it | |
| null -> unspecified | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.TerminalLoggerDefaultSource"> | |
| <summary> | |
| How was default behavior signaled: | |
| sdk -> from SDK | |
| DOTNET_CLI_CONFIGURE_MSBUILD_TERMINAL_LOGGER -> from environment variable | |
| msbuild -> MSBuild hardcoded default | |
| null -> unspecified | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.ConsoleLogger"> | |
| <summary> | |
| True if console logger was used. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.ConsoleLoggerType"> | |
| <summary> | |
| Type of console logger: serial | parallel | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.ConsoleLoggerVerbosity"> | |
| <summary> | |
| Verbosity of console logger: quiet | minimal | normal | detailed | diagnostic | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.FileLogger"> | |
| <summary> | |
| True if file logger was used. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.FileLoggerType"> | |
| <summary> | |
| Type of file logger: serial | parallel | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.FileLoggersCount"> | |
| <summary> | |
| Number of file loggers. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.FileLoggerVerbosity"> | |
| <summary> | |
| Verbosity of file logger: quiet | minimal | normal | detailed | diagnostic | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.BinaryLogger"> | |
| <summary> | |
| True if binary logger was used. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.LoggingConfigurationTelemetry.BinaryLoggerUsedDefaultName"> | |
| <summary> | |
| True if binary logger used default name i.e. no LogFile was specified. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.Telemetry.TelemetryBase.EventName"> | |
| <summary> | |
| Gets or sets the name of the event. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.Telemetry.TelemetryBase.GetProperties"> | |
| <summary> | |
| Fetches all derived type members wrapped in Dictionary which will be used to build <see cref="T:Microsoft.Build.Framework.TelemetryEventArgs"/>. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.Traits"> | |
| <summary> | |
| Represents toggleable features of the MSBuild engine | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.UseLazyWildCardEvaluation"> | |
| <summary> | |
| Do not expand wildcards that match a certain pattern | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.CacheFileExistence"> | |
| <summary> | |
| Cache file existence for the entire process | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.MSBuildCacheFileEnumerations"> | |
| <summary> | |
| Cache wildcard expansions for the entire process | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.EnableRestoreFirst"> | |
| <summary> | |
| Enable restore first functionality in MSBuild.exe | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.MSBuildNodeHandshakeSalt"> | |
| <summary> | |
| Allow the user to specify that two processes should not be communicating via an environment variable. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.ForceEvaluateAsFullFramework"> | |
| <summary> | |
| Override property "MSBuildRuntimeType" to "Full", ignoring the actual runtime type of MSBuild. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.CopyTaskParallelism"> | |
| <summary> | |
| Setting the associated environment variable to 1 restores the pre-15.8 single | |
| threaded (slower) copy behavior. Zero implies Int32.MaxValue, less than zero | |
| (default) uses the empirical default in Copy.cs, greater than zero can allow | |
| perf tuning beyond the defaults chosen. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.EmitSolutionMetaproj"> | |
| <summary> | |
| Instruct MSBuild to write out the generated "metaproj" file to disk when building a solution file. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.SolutionBatchTargets"> | |
| <summary> | |
| Modifies Solution Generator to generate a metaproj that batches multiple Targets into one MSBuild task invoke. | |
| </summary> | |
| <remarks> | |
| For example, a run of Clean;Build target will first run Clean on all projects, | |
| then run Build on all projects. When enabled, it will run Clean;Build on all | |
| Projects at the back to back. Allowing the second target to start sooner than before. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.LogPropertyFunctionsRequiringReflection"> | |
| <summary> | |
| Log statistics about property functions which require reflection | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.LogAllAssemblyLoads"> | |
| <summary> | |
| Log all environment variables whether or not they are used in a build in the binary log. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.LogAllEnvironmentVariables"> | |
| <summary> | |
| Log all environment variables whether or not they are used in a build in the binary log. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.LogPropertyTracking"> | |
| <summary> | |
| Log property tracking information. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.DictionaryBasedItemRemoveThreshold"> | |
| <summary> | |
| When evaluating items, this is the minimum number of items on the running list to use a dictionary-based remove optimization. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.Traits.UseMSBuildServerEnvVarName"> | |
| <summary> | |
| Name of environment variables used to enable MSBuild server. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.DoNotSendDeferredMessagesToBuildManager"> | |
| <summary> | |
| Do not log command line information to build loggers. Useful to unbreak people who parse the msbuild log and who are unwilling to change their code. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.DoNotExpandQualifiedMetadataInUpdateOperation"> | |
| <summary> | |
| https://github.com/dotnet/msbuild/pull/4975 started expanding qualified metadata in Update operations. Before they'd expand to empty strings. | |
| This escape hatch turns back the old empty string behavior. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.EvaluateElementsWithFalseConditionInProjectEvaluation"> | |
| <summary> | |
| Force whether Project based evaluations should evaluate elements with false conditions. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.AlwaysUseContentTimestamp"> | |
| <summary> | |
| Always use the accurate-but-slow CreateFile approach to timestamp extraction. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.TruncateTaskInputs"> | |
| <summary> | |
| Truncate task inputs when logging them. This can reduce memory pressure | |
| at the expense of log usefulness. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.DoNotTruncateConditions"> | |
| <summary> | |
| Disables truncation of Condition messages in Tasks/Targets via ExpanderOptions.Truncate. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.AlwaysEvaluateDangerousGlobs"> | |
| <summary> | |
| Disables skipping full drive/filesystem globs that are behind a false condition. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.AlwaysDoImmutableFilesUpToDateCheck"> | |
| <summary> | |
| Disables skipping full up to date check for immutable files. See FileClassifier class. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.CopyWithoutDelete"> | |
| <summary> | |
| When copying over an existing file, copy directly into the existing file rather than deleting and recreating. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches._logProjectImports"> | |
| <summary> | |
| Emit events for project imports. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.EscapeHatches.LogProjectImports"> | |
| <summary> | |
| Emit events for project imports. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.CacheAssemblyInformation"> | |
| <summary> | |
| Read information only once per file per ResolveAssemblyReference invocation. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.UseSymlinkTimeInsteadOfTargetTime"> | |
| <summary> | |
| Never use the slow (but more accurate) CreateFile approach to timestamp extraction. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.ReuseTaskHostNodes"> | |
| <summary> | |
| Allow node reuse of TaskHost nodes. This results in task assemblies locked past the build lifetime, preventing them from being rebuilt if custom tasks change, but may improve performance. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.IgnoreEmptyImports"> | |
| <summary> | |
| Whether or not to ignore imports that are considered empty. See ProjectRootElement.IsEmptyXmlFile() for more info. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.IgnoreTreatAsLocalProperty"> | |
| <summary> | |
| Whether to respect the TreatAsLocalProperty parameter on the Project tag. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.DebugEvaluation"> | |
| <summary> | |
| Whether to write information about why we evaluate to debug output. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.WarnOnUninitializedProperty"> | |
| <summary> | |
| Whether to warn when we set a property for the first time, after it was previously used. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.UseCaseSensitiveItemNames"> | |
| <summary> | |
| MSBUILDUSECASESENSITIVEITEMNAMES is an escape hatch for the fix | |
| for https://github.com/dotnet/msbuild/issues/1751. It should | |
| be removed (permanently set to false) after establishing that | |
| it's unneeded (at least by the 16.0 timeframe). | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.DisableLongPaths"> | |
| <summary> | |
| Disable the use of paths longer than Windows MAX_PATH limits (260 characters) when running on a long path enabled OS. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.DisableSdkResolutionCache"> | |
| <summary> | |
| Disable the use of any caching when resolving SDKs. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.TargetPathForRelatedFiles"> | |
| <summary> | |
| Don't delete TargetPath metadata from associated files found by RAR. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.UseSingleLoadContext"> | |
| <summary> | |
| Disable AssemblyLoadContext isolation for plugins. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.UseAutoRunWhenLaunchingProcessUnderCmd"> | |
| <summary> | |
| Enables the user of autorun functionality in CMD.exe on Windows which is disabled by default in MSBuild. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.AvoidUnicodeWhenWritingToolTaskBatch"> | |
| <summary> | |
| Disables switching codepage to UTF-8 after detection of characters that can't be represented in the current codepage. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.EnsureStdOutForChildNodesIsPrimaryStdout"> | |
| <summary> | |
| Workaround for https://github.com/Microsoft/vstest/issues/1503. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Framework.EscapeHatches.UseMinimalResxParsingInCoreScenarios"> | |
| <summary> | |
| Use the original, string-only resx parsing in .NET Core scenarios. | |
| </summary> | |
| <remarks> | |
| Escape hatch for problems arising from https://github.com/dotnet/msbuild/pull/4420. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.EscapeHatches.SdkReferencePropertyExpansion"> | |
| <summary> | |
| Overrides the default behavior of property expansion on evaluation of a <see cref="T:Microsoft.Build.Framework.SdkReference"/>. | |
| </summary> | |
| <remarks> | |
| Escape hatch for problems arising from https://github.com/dotnet/msbuild/pull/5552. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.EscapeHatches.EnableWarningOnCustomBuildEvent"> | |
| <summary> | |
| Allows displaying the deprecation warning for BinaryFormatter in your current environment. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EscapeHatches.ThrowInternalError(System.String)"> | |
| <summary> | |
| Throws InternalErrorException. | |
| </summary> | |
| <remarks> | |
| Clone of ErrorUtilities.ThrowInternalError which isn't available in Framework. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EscapeHatches.ThrowInternalError(System.String,System.Object[])"> | |
| <summary> | |
| Throws InternalErrorException. | |
| This is only for situations that would mean that there is a bug in MSBuild itself. | |
| </summary> | |
| <remarks> | |
| Clone from ErrorUtilities which isn't available in Framework. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.EscapeHatches.FormatString(System.String,System.Object[])"> | |
| <summary> | |
| Formats the given string using the variable arguments passed in. | |
| PERF WARNING: calling a method that takes a variable number of arguments is expensive, because memory is allocated for | |
| the array of arguments -- do not call this method repeatedly in performance-critical scenarios | |
| Thread safe. | |
| </summary> | |
| <param name="unformatted">The string to format.</param> | |
| <param name="args">Optional arguments for formatting the given string.</param> | |
| <returns>The formatted string.</returns> | |
| <remarks> | |
| Clone from ResourceUtilities which isn't available in Framework. | |
| </remarks> | |
| </member> | |
| <member name="T:Microsoft.Build.Framework.UninitializedPropertyReadEventArgs"> | |
| <summary> | |
| The arguments for an uninitialized property read event. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.UninitializedPropertyReadEventArgs.#ctor"> | |
| <summary> | |
| UninitializedPropertyReadEventArgs | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Framework.UninitializedPropertyReadEventArgs.#ctor(System.String,System.String,System.String,System.String,Microsoft.Build.Framework.MessageImportance)"> | |
| <summary> | |
| Creates an instance of the UninitializedPropertyReadEventArgs class | |
| </summary> | |
| <param name="propertyName">The name of the uninitialized property that was read.</param> | |
| <param name="message">The message of the uninitialized property that was read.</param> | |
| <param name="helpKeyword">The helpKeyword of the uninitialized property that was read.</param> | |
| <param name="senderName">The sender name of the event.</param> | |
| <param name="importance">The message importance of the event.</param> | |
| </member> | |
| <member name="P:Microsoft.Build.Framework.UninitializedPropertyReadEventArgs.PropertyName"> | |
| <summary> | |
| The name of the uninitialized property that was read. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Shared.AssemblyUtilities"> | |
| <summary> | |
| This class contains common reflection tasks | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.AssemblyUtilities.Initialize"> | |
| <summary> | |
| Initialize static fields. Doesn't need to be thread safe. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Shared.EncodingUtilities"> | |
| <summary> | |
| This class contains utility methods for dealing with encoding. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Shared.EncodingUtilities.CurrentSystemOemEncoding"> | |
| <summary> | |
| Get the current system locale code page, OEM version. OEM code pages are used for console-based input/output | |
| for historical reasons. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.EncodingUtilities.SimilarToEncoding(System.Text.Encoding,System.Text.Encoding)"> | |
| <summary> | |
| Checks two encoding types to determine if they are similar to each other (equal or if | |
| the Encoding Name is the same). | |
| </summary> | |
| <param name="encoding1"></param> | |
| <param name="encoding2"></param> | |
| <returns>True if the two Encoding objects are equal or similar.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.EncodingUtilities.IsUtf8Encoding(System.Text.Encoding)"> | |
| <summary> | |
| Check if an encoding type is UTF8 (with or without BOM). | |
| </summary> | |
| <param name="encoding"></param> | |
| <returns>True if the encoding is UTF8.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.EncodingUtilities.StartsWithPreamble(System.IO.Stream)"> | |
| <summary> | |
| Check the first 3 bytes of a stream to determine if it matches the UTF8 preamble. | |
| </summary> | |
| <param name="stream">Steam to check.</param> | |
| <returns>True when the first 3 bytes of the Stream are equal to the UTF8 preamble (BOM).</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.EncodingUtilities.StartsWithPreamble(System.IO.Stream,System.Byte[])"> | |
| <summary> | |
| Check the first 3 bytes of a stream to determine if it matches the given preamble. | |
| </summary> | |
| <param name="stream">Steam to check.</param> | |
| <param name="preamble">Preamble to look for.</param> | |
| <returns>True when the first 3 bytes of the Stream are equal to the preamble.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.EncodingUtilities.FileStartsWithPreamble(System.String)"> | |
| <summary> | |
| Check the first 3 bytes of a file to determine if it matches the 3-byte UTF8 preamble (BOM). | |
| </summary> | |
| <param name="file">Path to file to check.</param> | |
| <returns>True when the first 3 bytes of the file are equal to the UTF8 BOM.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.EncodingUtilities.CanEncodeString(System.Int32,System.String)"> | |
| <summary> | |
| Checks to see if a string can be encoded in a specified code page. | |
| </summary> | |
| <remarks>Internal for testing purposes.</remarks> | |
| <param name="codePage">Code page for encoding.</param> | |
| <param name="stringToEncode">String to encode.</param> | |
| <returns>True if the string can be encoded in the specified code page.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.EncodingUtilities.BatchFileEncoding(System.String,System.String)"> | |
| <summary> | |
| Find the encoding for the batch file. | |
| </summary> | |
| <remarks> | |
| The "best" encoding is the current OEM encoding, unless it's not capable of representing | |
| the characters we plan to put in the file. If it isn't, we can fall back to UTF-8. | |
| Why not always UTF-8? Because tools don't always handle it well. See | |
| https://github.com/dotnet/msbuild/issues/397 | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.EncodingUtilities.GetExternalOverriddenUILanguageIfSupportableWithEncoding"> | |
| <summary> | |
| The .NET SDK and Visual Studio both have environment variables that set a custom language. MSBuild should respect the SDK variable. | |
| To use the corresponding UI culture, in certain cases the console encoding must be changed. This function will change the encoding in these cases. | |
| This code introduces a breaking change in .NET 8 due to the encoding of the console being changed. | |
| If the environment variables are undefined, this function should be a no-op. | |
| </summary> | |
| <returns> | |
| The custom language that was set by the user for an 'external' tool besides MSBuild. | |
| Returns <see langword="null"/> if none are set. | |
| </returns> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.EncodingUtilities.GetExternalOverriddenUILanguage"> | |
| <summary> | |
| Look at UI language overrides that can be set by known external invokers. (DOTNET_CLI_UI_LANGUAGE.) | |
| Does NOT check System Locale or OS Display Language. | |
| Ported from the .NET SDK: https://github.com/dotnet/sdk/blob/bcea1face15458814b8e53e8785b52ba464f6538/src/Cli/Microsoft.DotNet.Cli.Utils/UILanguageOverride.cs | |
| </summary> | |
| <returns>The custom language that was set by the user for an 'external' tool besides MSBuild. | |
| Returns null if none are set.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Shared.VisualStudioLocationHelper"> | |
| <summary> | |
| Helper class to wrap the Microsoft.VisualStudio.Setup.Configuration.Interop API to query | |
| Visual Studio setup for instances installed on the machine. | |
| Code derived from sample: https://code.msdn.microsoft.com/Visual-Studio-Setup-0cedd331 | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Shared.VisualStudioLocationHelper.GetInstances"> | |
| <summary> | |
| Query the Visual Studio setup API to get instances of Visual Studio installed | |
| on the machine. Will not include anything before Visual Studio "15". | |
| </summary> | |
| <returns>Enumerable list of Visual Studio instances</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Shared.VisualStudioInstance"> | |
| <summary> | |
| Wrapper class to represent an installed instance of Visual Studio. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Shared.VisualStudioInstance.Version"> | |
| <summary> | |
| Version of the Visual Studio Instance | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Shared.VisualStudioInstance.Path"> | |
| <summary> | |
| Path to the Visual Studio installation | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.Shared.VisualStudioInstance.Name"> | |
| <summary> | |
| Full name of the Visual Studio instance with SKU name | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Shared.MSBuildConstants"> | |
| <summary> | |
| Constants that we want to be shareable across all our assemblies. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.ToolsPath"> | |
| <summary> | |
| The name of the property that indicates the tools path | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.ToolsPath64"> | |
| <summary> | |
| Name of the property that indicates the X64 tools path | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.SdksPath"> | |
| <summary> | |
| Name of the property that indicates the root of the SDKs folder | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.TreatWarningsAsErrors"> | |
| <summary> | |
| Name of the property that indicates that all warnings should be treated as errors. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.WarningsAsErrors"> | |
| <summary> | |
| Name of the property that indicates a list of warnings to treat as errors. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.WarningsNotAsErrors"> | |
| <summary> | |
| Name of the property that indicates a list of warnings to not treat as errors. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.WarningsAsMessages"> | |
| <summary> | |
| Name of the property that indicates the list of warnings to treat as messages. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.NuGetAssemblyPathEnvironmentVariableName"> | |
| <summary> | |
| The name of the environment variable that users can specify to override where NuGet assemblies are loaded from in the NuGetSdkResolver. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.RestoreTargetName"> | |
| <summary> | |
| The name of the target to run when a user specifies the /restore command-line argument. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.CurrentVisualStudioVersion"> | |
| <summary> | |
| The most current Visual Studio Version known to this version of MSBuild. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.CurrentToolsVersion"> | |
| <summary> | |
| The most current ToolsVersion known to this version of MSBuild. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.MSBuildRestoreSessionId"> | |
| <summary> | |
| A property set during an implicit restore (/restore) or explicit restore (/t:restore) to ensure that the evaluations are not re-used during build | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.MSBuildIsRestoring"> | |
| <summary> | |
| A property set during an implicit restore (/restore) or explicit restore (/t:restore) to indicate that a restore is executing. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.CurrentAssemblyVersion"> | |
| <summary> | |
| The most current VSGeneralAssemblyVersion known to this version of MSBuild. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.CurrentProductVersion"> | |
| <summary> | |
| Current version of this MSBuild Engine assembly in the form, e.g, "12.0" | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.DefaultTargetsMarker"> | |
| <summary> | |
| Symbol used in ProjectReferenceTarget items to represent default targets | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.StandardTestTargetFrameworkVersion"> | |
| <summary> | |
| Framework version against which our test projects should be built. | |
| </summary> | |
| <remarks> | |
| The targeting pack for this version of .NET Framework must be installed | |
| on any machine that wants to run tests successfully, so this can be | |
| periodically updated. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.MSBuildConstants.ProjectReferenceTargetsOrDefaultTargetsMarker"> | |
| <summary> | |
| Symbol used in ProjectReferenceTarget items to represent targets specified on the ProjectReference item | |
| with fallback to default targets if the ProjectReference item has no targets specified. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.PropertyNames.IsGraphBuild"> | |
| <summary> | |
| Specifies whether the current evaluation / build is happening during a graph build | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.ItemTypeNames.ProjectReference"> | |
| <summary> | |
| References to other msbuild projects | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.ItemTypeNames.ProjectReferenceTargets"> | |
| <summary> | |
| Statically specifies what targets a project calls on its references | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.ItemTypeNames.ProjectCachePlugin"> | |
| <summary> | |
| Declares a project cache plugin and its configuration. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.ItemTypeNames.EmbedInBinlog"> | |
| <summary> | |
| Embed specified files in the binary log | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Shared.ItemMetadataNames"> | |
| <summary> | |
| Constants naming well-known item metadata. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Shared.ItemMetadataNames.targetPath"> | |
| <summary> | |
| The output path for a given item. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.BinaryReaderFactory"> | |
| <summary> | |
| Opaque holder of shared buffer. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.BackEnd.BinaryTranslator"> | |
| <summary> | |
| This class is responsible for serializing and deserializing simple types to and | |
| from the byte streams used to communicate INodePacket-implementing classes. | |
| Each class implements a Translate method on INodePacket which takes this class | |
| as a parameter, and uses it to store and retrieve fields to the stream. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.GetReadTranslator(System.IO.Stream,Microsoft.Build.BinaryReaderFactory)"> | |
| <summary> | |
| Returns a read-only serializer. | |
| </summary> | |
| <returns>The serializer.</returns> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.GetWriteTranslator(System.IO.Stream)"> | |
| <summary> | |
| Returns a write-only serializer. | |
| </summary> | |
| <param name="stream">The stream containing data to serialize.</param> | |
| <returns>The serializer.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator"> | |
| <summary> | |
| Implementation of ITranslator for reading from a stream. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator._packetStream"> | |
| <summary> | |
| The stream used as a source or destination for data. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator._reader"> | |
| <summary> | |
| The binary reader used in read mode. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.#ctor(System.IO.Stream,Microsoft.Build.BinaryReaderFactory)"> | |
| <summary> | |
| Constructs a serializer from the specified stream, operating in the designated mode. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Dispose"> | |
| <summary> | |
| Delegates the Dispose call the to the underlying BinaryReader. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Reader"> | |
| <summary> | |
| Gets the reader, if any. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Writer"> | |
| <summary> | |
| Gets the writer, if any. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Mode"> | |
| <summary> | |
| Returns the current serialization mode. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Boolean@)"> | |
| <summary> | |
| Translates a boolean. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Boolean[]@)"> | |
| <summary> | |
| Translates an <see langword="bool"/> array. | |
| </summary> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Byte@)"> | |
| <summary> | |
| Translates a byte. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Int16@)"> | |
| <summary> | |
| Translates a short. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.UInt16@)"> | |
| <summary> | |
| Translates an unsigned short. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Int32@)"> | |
| <summary> | |
| Translates an integer. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.UInt32@)"> | |
| <inheritdoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Int32[]@)"> | |
| <summary> | |
| Translates an <see langword="int"/> array. | |
| </summary> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Int64@)"> | |
| <summary> | |
| Translates a long. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Double@)"> | |
| <summary> | |
| Translates a double. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.String@)"> | |
| <summary> | |
| Translates a string. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Byte[]@)"> | |
| <summary> | |
| Translates a byte array | |
| </summary> | |
| <param name="byteArray">The array to be translated</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Byte[]@,System.Int32@)"> | |
| <summary> | |
| Translates a byte array | |
| </summary> | |
| <param name="byteArray">The array to be translated.</param> | |
| <param name="length">The length of array which will be used in translation. This parameter is not used when reading</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.String[]@)"> | |
| <summary> | |
| Translates a string array. | |
| </summary> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Collections.Generic.HashSet{System.String}@)"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.Collections.Generic.List{System.String}@)"> | |
| <summary> | |
| Translates a list of strings | |
| </summary> | |
| <param name="list">The list to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate``1(System.Collections.Generic.List{``0}@,Microsoft.Build.BackEnd.ObjectTranslator{``0})"> | |
| <summary> | |
| Translates a list of T using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> | |
| </summary> | |
| <param name="list">The list to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the items in the list</param> | |
| <typeparam name="T">TaskItem type</typeparam> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate``2(System.Collections.Generic.ICollection{``0}@,Microsoft.Build.BackEnd.ObjectTranslator{``0},Microsoft.Build.BackEnd.NodePacketCollectionCreator{``1})"> | |
| <summary> | |
| Translates a collection of T into the specified type using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> and <see cref="T:Microsoft.Build.BackEnd.NodePacketCollectionCreator`1"/> | |
| </summary> | |
| <param name="collection">The collection to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the values in the collection.</param> | |
| <param name="collectionFactory">The factory to create the ICollection.</param> | |
| <typeparam name="T">The type contained in the collection.</typeparam> | |
| <typeparam name="L">The type of collection to be created.</typeparam> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.DateTime@)"> | |
| <summary> | |
| Translates a DateTime. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(System.TimeSpan@)"> | |
| <summary> | |
| Translates a TimeSpan. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate(Microsoft.Build.Framework.BuildEventContext@)"> | |
| <summary> | |
| Translates a BuildEventContext | |
| </summary> | |
| <remarks> | |
| This method exists only because there is no serialization method built into the BuildEventContext | |
| class, and it lives in Framework and we don't want to add a public method to it. | |
| </remarks> | |
| <param name="value">The context to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateCulture(System.Globalization.CultureInfo@)"> | |
| <summary> | |
| Translates a CultureInfo | |
| </summary> | |
| <param name="value">The CultureInfo to translate</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateEnum``1(``0@,System.Int32)"> | |
| <summary> | |
| Translates an enumeration. | |
| </summary> | |
| <typeparam name="T">The enumeration type.</typeparam> | |
| <param name="value">The enumeration instance to be translated.</param> | |
| <param name="numericValue">The enumeration value as an integer.</param> | |
| <remarks>This is a bit ugly, but it doesn't seem like a nice method signature is possible because | |
| you can't pass the enum type as a reference and constrain the generic parameter to Enum. Nor | |
| can you simply pass as ref Enum, because an enum instance doesn't match that function signature. | |
| Finally, converting the enum to an int assumes that we always want to transport enums as ints. This | |
| works in all of our current cases, but certainly isn't perfectly generic.</remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateDotNet``1(``0@)"> | |
| <summary> | |
| Translates a value using the .Net binary formatter. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.Translate``1(``0@)"> | |
| <summary> | |
| Translates an object implementing INodePacketTranslatable. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateArray``1(``0[]@)"> | |
| <summary> | |
| Translates an array of objects implementing INodePacketTranslatable. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateArray``1(``0[]@,Microsoft.Build.BackEnd.ObjectTranslator{``0})"> | |
| <summary> | |
| Translates an array of objects using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="array">The array to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the elements in the array</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateDictionary(System.Collections.Generic.Dictionary{System.String,System.String}@,System.Collections.Generic.IEqualityComparer{System.String})"> | |
| <summary> | |
| Translates a dictionary of { string, string }. | |
| </summary> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="comparer">The comparer used to instantiate the dictionary.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateDictionary``1(System.Collections.Generic.Dictionary{System.String,``0}@,System.Collections.Generic.IEqualityComparer{System.String},Microsoft.Build.BackEnd.ObjectTranslator{``0})"> | |
| <summary> | |
| Translates a dictionary of { string, T }. | |
| </summary> | |
| <typeparam name="T">The reference type for the values</typeparam> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="comparer">The comparer used to instantiate the dictionary.</param> | |
| <param name="objectTranslator">The translator to use for the values in the dictionary</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateDictionary``2(``0@,Microsoft.Build.BackEnd.ObjectTranslator{``1})"> | |
| <summary> | |
| Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. | |
| </summary> | |
| <typeparam name="D">The reference type for the dictionary.</typeparam> | |
| <typeparam name="T">The reference type for values in the dictionary.</typeparam> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the values in the dictionary</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateDictionary``2(``0@,Microsoft.Build.BackEnd.ObjectTranslator{``1},Microsoft.Build.BackEnd.NodePacketCollectionCreator{``0})"> | |
| <summary> | |
| Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. | |
| </summary> | |
| <typeparam name="D">The reference type for the dictionary.</typeparam> | |
| <typeparam name="T">The reference type for values in the dictionary.</typeparam> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the values in the dictionary</param> | |
| <param name="dictionaryCreator">The delegate used to instantiate the dictionary.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryReadTranslator.TranslateNullable``1(``0)"> | |
| <summary> | |
| Reads in the boolean which says if this object is null or not. | |
| </summary> | |
| <typeparam name="T">The type of object to test.</typeparam> | |
| <returns>True if the object should be read, false otherwise.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator"> | |
| <summary> | |
| Implementation of ITranslator for writing to a stream. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator._packetStream"> | |
| <summary> | |
| The stream used as a source or destination for data. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator._writer"> | |
| <summary> | |
| The binary writer used in write mode. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.#ctor(System.IO.Stream)"> | |
| <summary> | |
| Constructs a serializer from the specified stream, operating in the designated mode. | |
| </summary> | |
| <param name="packetStream">The stream serving as the source or destination of data.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Dispose"> | |
| <summary> | |
| Delegates the Dispose call the to the underlying BinaryWriter. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Reader"> | |
| <summary> | |
| Gets the reader, if any. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Writer"> | |
| <summary> | |
| Gets the writer, if any. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Mode"> | |
| <summary> | |
| Returns the current serialization mode. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Boolean@)"> | |
| <summary> | |
| Translates a boolean. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Boolean[]@)"> | |
| <summary> | |
| Translates an <see langword="bool"/> array. | |
| </summary> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Byte@)"> | |
| <summary> | |
| Translates a byte. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Int16@)"> | |
| <summary> | |
| Translates a short. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.UInt16@)"> | |
| <summary> | |
| Translates an unsigned short. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Int32@)"> | |
| <summary> | |
| Translates an integer. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.UInt32@)"> | |
| <inheritdoc/> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Int32[]@)"> | |
| <summary> | |
| Translates an <see langword="int"/> array. | |
| </summary> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Int64@)"> | |
| <summary> | |
| Translates a long. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Double@)"> | |
| <summary> | |
| Translates a double. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.String@)"> | |
| <summary> | |
| Translates a string. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.String[]@)"> | |
| <summary> | |
| Translates a string array. | |
| </summary> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Collections.Generic.List{System.String}@)"> | |
| <summary> | |
| Translates a list of strings | |
| </summary> | |
| <param name="list">The list to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Collections.Generic.HashSet{System.String}@)"> | |
| <inheritdoc /> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate``1(System.Collections.Generic.List{``0}@,Microsoft.Build.BackEnd.ObjectTranslator{``0})"> | |
| <summary> | |
| Translates a list of T using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> | |
| </summary> | |
| <param name="list">The list to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the items in the list</param> | |
| <typeparam name="T">A TaskItemType</typeparam> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate``2(System.Collections.Generic.IList{``0}@,Microsoft.Build.BackEnd.ObjectTranslator{``0},Microsoft.Build.BackEnd.NodePacketCollectionCreator{``1})"> | |
| <summary> | |
| Translates a list of T using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> | |
| </summary> | |
| <param name="list">The list to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the items in the list</param> | |
| <param name="collectionFactory">factory to create the IList</param> | |
| <typeparam name="T">A TaskItemType</typeparam> | |
| <typeparam name="L">IList subtype</typeparam> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate``2(System.Collections.Generic.ICollection{``0}@,Microsoft.Build.BackEnd.ObjectTranslator{``0},Microsoft.Build.BackEnd.NodePacketCollectionCreator{``1})"> | |
| <summary> | |
| Translates a collection of T into the specified type using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> and <see cref="T:Microsoft.Build.BackEnd.NodePacketCollectionCreator`1"/> | |
| </summary> | |
| <param name="collection">The collection to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the values in the collection.</param> | |
| <param name="collectionFactory">The factory to create the ICollection.</param> | |
| <typeparam name="T">The type contained in the collection.</typeparam> | |
| <typeparam name="L">The type of collection to be created.</typeparam> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.DateTime@)"> | |
| <summary> | |
| Translates a DateTime. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.TimeSpan@)"> | |
| <summary> | |
| Translates a TimeSpan. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(Microsoft.Build.Framework.BuildEventContext@)"> | |
| <summary> | |
| Translates a BuildEventContext | |
| </summary> | |
| <remarks> | |
| This method exists only because there is no serialization method built into the BuildEventContext | |
| class, and it lives in Framework and we don't want to add a public method to it. | |
| </remarks> | |
| <param name="value">The context to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateCulture(System.Globalization.CultureInfo@)"> | |
| <summary> | |
| Translates a CultureInfo | |
| </summary> | |
| <param name="value">The CultureInfo</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateEnum``1(``0@,System.Int32)"> | |
| <summary> | |
| Translates an enumeration. | |
| </summary> | |
| <typeparam name="T">The enumeration type.</typeparam> | |
| <param name="value">The enumeration instance to be translated.</param> | |
| <param name="numericValue">The enumeration value as an integer.</param> | |
| <remarks>This is a bit ugly, but it doesn't seem like a nice method signature is possible because | |
| you can't pass the enum type as a reference and constrain the generic parameter to Enum. Nor | |
| can you simply pass as ref Enum, because an enum instance doesn't match that function signature. | |
| Finally, converting the enum to an int assumes that we always want to transport enums as ints. This | |
| works in all of our current cases, but certainly isn't perfectly generic.</remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateDotNet``1(``0@)"> | |
| <summary> | |
| Translates a value using the .Net binary formatter. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate``1(``0@)"> | |
| <summary> | |
| Translates an object implementing INodePacketTranslatable. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Byte[]@)"> | |
| <summary> | |
| Translates a byte array | |
| </summary> | |
| <param name="byteArray">The byte array to be translated</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.Translate(System.Byte[]@,System.Int32@)"> | |
| <summary> | |
| Translates a byte array | |
| </summary> | |
| <param name="byteArray">The array to be translated.</param> | |
| <param name="length">The length of array which will be used in translation</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateArray``1(``0[]@)"> | |
| <summary> | |
| Translates an array of objects implementing INodePacketTranslatable. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateArray``1(``0[]@,Microsoft.Build.BackEnd.ObjectTranslator{``0})"> | |
| <summary> | |
| Translates an array of objects using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="array">The array to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the elements in the array</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateDictionary(System.Collections.Generic.Dictionary{System.String,System.String}@,System.Collections.Generic.IEqualityComparer{System.String})"> | |
| <summary> | |
| Translates a dictionary of { string, string }. | |
| </summary> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="comparer">The comparer used to instantiate the dictionary.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateDictionary``1(System.Collections.Generic.Dictionary{System.String,``0}@,System.Collections.Generic.IEqualityComparer{System.String},Microsoft.Build.BackEnd.ObjectTranslator{``0})"> | |
| <summary> | |
| Translates a dictionary of { string, T }. | |
| </summary> | |
| <typeparam name="T">The reference type for the values, which implements INodePacketTranslatable.</typeparam> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="comparer">The comparer used to instantiate the dictionary.</param> | |
| <param name="objectTranslator">The translator to use for the values in the dictionary</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateDictionary``2(``0@,Microsoft.Build.BackEnd.ObjectTranslator{``1})"> | |
| <summary> | |
| Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. | |
| </summary> | |
| <typeparam name="D">The reference type for the dictionary.</typeparam> | |
| <typeparam name="T">The reference type for values in the dictionary.</typeparam> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the values in the dictionary</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateDictionary``2(``0@,Microsoft.Build.BackEnd.ObjectTranslator{``1},Microsoft.Build.BackEnd.NodePacketCollectionCreator{``0})"> | |
| <summary> | |
| Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. | |
| </summary> | |
| <typeparam name="D">The reference type for the dictionary.</typeparam> | |
| <typeparam name="T">The reference type for values in the dictionary.</typeparam> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the values in the dictionary</param> | |
| <param name="dictionaryCreator">The delegate used to instantiate the dictionary.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateDictionary(System.Collections.Generic.Dictionary{System.String,System.DateTime}@,System.StringComparer)"> | |
| <summary> | |
| Translates a dictionary of { string, DateTime }. | |
| </summary> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="comparer">Key comparer</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.BinaryTranslator.BinaryWriteTranslator.TranslateNullable``1(``0)"> | |
| <summary> | |
| Writes out the boolean which says if this object is null or not. | |
| </summary> | |
| <param name="value">The object to test.</param> | |
| <typeparam name="T">The type of object to test.</typeparam> | |
| <returns>True if the object should be written, false otherwise.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.BackEnd.ITranslatable"> | |
| <summary> | |
| An interface representing an object which may be serialized by the node packet serializer. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslatable.Translate(Microsoft.Build.BackEnd.ITranslator)"> | |
| <summary> | |
| Reads or writes the packet to the serializer. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.BackEnd.NodePacketValueFactory`1"> | |
| <summary> | |
| This delegate is used for objects which do not have public parameterless constructors and must be constructed using | |
| another method. When invoked, this delegate should return a new object which has been translated appropriately. | |
| </summary> | |
| <typeparam name="T">The type to be translated.</typeparam> | |
| </member> | |
| <member name="T:Microsoft.Build.BackEnd.ObjectTranslator`1"> | |
| <summary> | |
| Delegate for users that want to translate an arbitrary structure that doesn't implement <see cref="T:Microsoft.Build.BackEnd.ITranslatable"/> (e.g. translating a complex collection) | |
| </summary> | |
| <param name="translator">the translator</param> | |
| <param name="objectToTranslate">the object to translate</param> | |
| </member> | |
| <member name="T:Microsoft.Build.BackEnd.NodePacketCollectionCreator`1"> | |
| <summary> | |
| This delegate is used to create arbitrary collection types for serialization. | |
| </summary> | |
| <typeparam name="T">The type of dictionary to be created.</typeparam> | |
| </member> | |
| <member name="T:Microsoft.Build.BackEnd.TranslationDirection"> | |
| <summary> | |
| The serialization mode. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.BackEnd.TranslationDirection.WriteToStream"> | |
| <summary> | |
| Indicates the serializer is operating in write mode. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.BackEnd.TranslationDirection.ReadFromStream"> | |
| <summary> | |
| Indicates the serializer is operating in read mode. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.BackEnd.ITranslator"> | |
| <summary> | |
| This interface represents an object which aids objects in serializing and | |
| deserializing INodePackets. | |
| </summary> | |
| <remarks> | |
| The reason we bother with a custom serialization mechanism at all is two fold: | |
| 1. The .Net serialization mechanism is inefficient, even if you implement ISerializable | |
| with your own custom mechanism. This is because the serializer uses a bag called | |
| SerializationInfo into which you are expected to drop all your data. This adds | |
| an unnecessary level of indirection to the serialization routines and prevents direct, | |
| efficient access to the byte-stream. | |
| 2. You have to implement both a reader and writer part, which introduces the potential for | |
| error should the classes be later modified. If the reader and writer methods are not | |
| kept in perfect sync, serialization errors will occur. Our custom serializer eliminates | |
| that by ensuring a single Translate method on a given object can handle both reads and | |
| writes without referencing any field more than once. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.BackEnd.ITranslator.Mode"> | |
| <summary> | |
| Returns the current serialization mode. | |
| </summary> | |
| </member> | |
| <member name="P:Microsoft.Build.BackEnd.ITranslator.Reader"> | |
| <summary> | |
| Returns the binary reader. | |
| </summary> | |
| <remarks> | |
| This should ONLY be used when absolutely necessary for translation. It is generally unnecessary for the | |
| translating object to know the direction of translation. Use one of the Translate methods instead. | |
| </remarks> | |
| </member> | |
| <member name="P:Microsoft.Build.BackEnd.ITranslator.Writer"> | |
| <summary> | |
| Returns the binary writer. | |
| </summary> | |
| <remarks> | |
| This should ONLY be used when absolutely necessary for translation. It is generally unnecessary for the | |
| translating object to know the direction of translation. Use one of the Translate methods instead. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Boolean@)"> | |
| <summary> | |
| Translates a boolean. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Boolean[]@)"> | |
| <summary> | |
| Translates an <see langword="bool"/> array. | |
| </summary> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Byte@)"> | |
| <summary> | |
| Translates a byte. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Int16@)"> | |
| <summary> | |
| Translates a short. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.UInt16@)"> | |
| <summary> | |
| Translates a unsigned short. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Int32@)"> | |
| <summary> | |
| Translates an integer. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.UInt32@)"> | |
| <summary> | |
| Translates an unsigned integer. | |
| </summary> | |
| <param name="unsignedInteger">The unsigned integer to translate.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Int32[]@)"> | |
| <summary> | |
| Translates an <see langword="int"/> array. | |
| </summary> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Int64@)"> | |
| <summary> | |
| Translates a long. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.String@)"> | |
| <summary> | |
| Translates a string. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Double@)"> | |
| <summary> | |
| Translates a double. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.String[]@)"> | |
| <summary> | |
| Translates a string array. | |
| </summary> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Collections.Generic.List{System.String}@)"> | |
| <summary> | |
| Translates a list of strings | |
| </summary> | |
| <param name="list">The list to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Collections.Generic.HashSet{System.String}@)"> | |
| <summary> | |
| Translates a set of strings | |
| </summary> | |
| <param name="set">The set to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate``1(System.Collections.Generic.List{``0}@,Microsoft.Build.BackEnd.ObjectTranslator{``0})"> | |
| <summary> | |
| Translates a list of T using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> | |
| </summary> | |
| <param name="list">The list to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the items in the list</param> | |
| <typeparam name="T">A TaskItemType</typeparam> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate``2(System.Collections.Generic.IList{``0}@,Microsoft.Build.BackEnd.ObjectTranslator{``0},Microsoft.Build.BackEnd.NodePacketCollectionCreator{``1})"> | |
| <summary> | |
| Translates a list of T using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> anda collection factory | |
| </summary> | |
| <param name="list">The list to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the items in the list</param> | |
| <typeparam name="T">An ITranslatable subtype</typeparam> | |
| <typeparam name="L">An IList subtype</typeparam> | |
| <param name="collectionFactory">factory to create a collection</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate``2(System.Collections.Generic.ICollection{``0}@,Microsoft.Build.BackEnd.ObjectTranslator{``0},Microsoft.Build.BackEnd.NodePacketCollectionCreator{``1})"> | |
| <summary> | |
| Translates a collection of T into the specified type using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/> and <see cref="T:Microsoft.Build.BackEnd.NodePacketCollectionCreator`1"/> | |
| </summary> | |
| <param name="collection">The collection to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the values in the collection.</param> | |
| <param name="collectionFactory">The factory to create the ICollection.</param> | |
| <typeparam name="T">The type contained in the collection.</typeparam> | |
| <typeparam name="L">The type of collection to be created.</typeparam> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.DateTime@)"> | |
| <summary> | |
| Translates a DateTime. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.TimeSpan@)"> | |
| <summary> | |
| Translates a TimeSpan. | |
| </summary> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(Microsoft.Build.Framework.BuildEventContext@)"> | |
| <summary> | |
| Translates a BuildEventContext | |
| </summary> | |
| <remarks> | |
| This method exists only because there is no serialization method built into the BuildEventContext | |
| class, and it lives in Framework and we don't want to add a public method to it. | |
| </remarks> | |
| <param name="value">The context to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateEnum``1(``0@,System.Int32)"> | |
| <summary> | |
| Translates an enumeration. | |
| </summary> | |
| <typeparam name="T">The enumeration type.</typeparam> | |
| <param name="value">The enumeration instance to be translated.</param> | |
| <param name="numericValue">The enumeration value as an integer.</param> | |
| <remarks>This is a bit ugly, but it doesn't seem like a nice method signature is possible because | |
| you can't pass the enum type as a reference and constrain the generic parameter to Enum. Nor | |
| can you simply pass as ref Enum, because an enum instance doesn't match that function signature. | |
| Finally, converting the enum to an int assumes that we always want to transport enums as ints. This | |
| works in all of our current cases, but certainly isn't perfectly generic.</remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateDotNet``1(``0@)"> | |
| <summary> | |
| Translates a value using the .Net binary formatter. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="value">The value to be translated.</param> | |
| <remarks> | |
| The primary purpose of this method is to support serialization of Exceptions and | |
| custom build logging events, since these do not support our custom serialization | |
| methods. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate``1(``0@)"> | |
| <summary> | |
| Translates an object implementing INodePacketTranslatable. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="value">The value to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateCulture(System.Globalization.CultureInfo@)"> | |
| <summary> | |
| Translates a culture | |
| </summary> | |
| <param name="culture">The culture</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Byte[]@)"> | |
| <summary> | |
| Translates a byte array | |
| </summary> | |
| <param name="byteArray">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.Translate(System.Byte[]@,System.Int32@)"> | |
| <summary> | |
| Translates a byte array | |
| </summary> | |
| <param name="byteArray">The array to be translated.</param> | |
| <param name="length">The length of array which will be used in translation</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateArray``1(``0[]@)"> | |
| <summary> | |
| Translates an array of objects implementing INodePacketTranslatable. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="array">The array to be translated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateArray``1(``0[]@,Microsoft.Build.BackEnd.ObjectTranslator{``0})"> | |
| <summary> | |
| Translates an array of objects using an <see cref="T:Microsoft.Build.BackEnd.ObjectTranslator`1"/>. | |
| </summary> | |
| <typeparam name="T">The reference type.</typeparam> | |
| <param name="array">The array to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the elements in the array.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateDictionary(System.Collections.Generic.Dictionary{System.String,System.String}@,System.Collections.Generic.IEqualityComparer{System.String})"> | |
| <summary> | |
| Translates a dictionary of { string, string }. | |
| </summary> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="comparer">The comparer used to instantiate the dictionary.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateDictionary``1(System.Collections.Generic.Dictionary{System.String,``0}@,System.Collections.Generic.IEqualityComparer{System.String},Microsoft.Build.BackEnd.ObjectTranslator{``0})"> | |
| <summary> | |
| Translates a dictionary of { string, T }. | |
| </summary> | |
| <typeparam name="T">The reference type for the values, which implements INodePacketTranslatable.</typeparam> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="comparer">The comparer used to instantiate the dictionary.</param> | |
| <param name="objectTranslator">The translator to use for the values in the dictionary</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateDictionary``2(``0@,Microsoft.Build.BackEnd.ObjectTranslator{``1})"> | |
| <summary> | |
| Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. | |
| </summary> | |
| <typeparam name="D">The reference type for the dictionary.</typeparam> | |
| <typeparam name="T">The reference type for values in the dictionary.</typeparam> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the values in the dictionary.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateDictionary``2(``0@,Microsoft.Build.BackEnd.ObjectTranslator{``1},Microsoft.Build.BackEnd.NodePacketCollectionCreator{``0})"> | |
| <summary> | |
| Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. | |
| </summary> | |
| <typeparam name="D">The reference type for the dictionary.</typeparam> | |
| <typeparam name="T">The reference type for values in the dictionary.</typeparam> | |
| <param name="dictionary">The dictionary to be translated.</param> | |
| <param name="objectTranslator">The translator to use for the values in the dictionary</param> | |
| <param name="collectionCreator">A factory used to create the dictionary.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.BackEnd.ITranslator.TranslateNullable``1(``0)"> | |
| <summary> | |
| Translates the boolean that says whether this value is null or not | |
| </summary> | |
| <param name="value">The object to test.</param> | |
| <typeparam name="T">The type of object to test.</typeparam> | |
| <returns>True if the object should be written, false otherwise.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Logging.TerminalLogger.AnsiCodes"> | |
| <summary> | |
| A collection of standard ANSI/VT100 control codes. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.CSI"> | |
| <summary> | |
| The control sequence introducer. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.SetColor"> | |
| <summary> | |
| Select graphic rendition. | |
| </summary> | |
| <remarks> | |
| Print <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.CSI"/>color-code<see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.SetColor"/> to change text color. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.SetBold"> | |
| <summary> | |
| Select graphic rendition - set bold mode. | |
| </summary> | |
| <remarks> | |
| Print <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.CSI"/><see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.SetBold"/> to change text to bold. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.SetDefaultColor"> | |
| <summary> | |
| A shortcut to reset color back to normal. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.LinkPrefix"> | |
| <summary> | |
| Non-xterm extension to render a hyperlink. | |
| </summary> | |
| <remarks> | |
| Print <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.LinkPrefix"/>url<see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.LinkInfix"/>text<see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.LinkSuffix"/> to render a hyperlink. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.LinkInfix"> | |
| <summary> | |
| <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.LinkPrefix"/> | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.LinkSuffix"> | |
| <summary> | |
| <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.LinkPrefix"/> | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.MoveUpToLineStart"> | |
| <summary> | |
| Moves up the specified number of lines and puts cursor at the beginning of the line. | |
| </summary> | |
| <remarks> | |
| Print <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.CSI"/>N<see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.MoveUpToLineStart"/> to move N lines up. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.MoveForward"> | |
| <summary> | |
| Moves forward (to the right) the specified number of characters. | |
| </summary> | |
| <remarks> | |
| Print <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.CSI"/>N<see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.MoveForward"/> to move N characters forward. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.MoveBackward"> | |
| <summary> | |
| Moves backward (to the left) the specified number of characters. | |
| </summary> | |
| <remarks> | |
| Print <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.CSI"/>N<see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.MoveBackward"/> to move N characters backward. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.EraseInDisplay"> | |
| <summary> | |
| Clears everything from cursor to end of screen. | |
| </summary> | |
| <remarks> | |
| Print <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.CSI"/><see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.EraseInDisplay"/> to clear. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.EraseInLine"> | |
| <summary> | |
| Clears everything from cursor to the end of the current line. | |
| </summary> | |
| <remarks> | |
| Print <see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.CSI"/><see cref="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.EraseInLine"/> to clear. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.HideCursor"> | |
| <summary> | |
| Hides the cursor. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.ShowCursor"> | |
| <summary> | |
| Shows/restores the cursor. | |
| </summary> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.SetProgressIndeterminate"> | |
| <summary> | |
| Set progress state to a busy spinner. <br/> | |
| Note: this code works only on ConEmu terminals, and conflicts with push a notification code on iTerm2. | |
| </summary> | |
| <remarks> | |
| <see href="https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC">ConEmu specific OSC codes.</see><br/> | |
| <see href="https://iterm2.com/documentation-escape-codes.html">iTerm2 proprietary escape codes.</see> | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.RemoveProgress"> | |
| <summary> | |
| Remove progress state, restoring taskbar status to normal. <br/> | |
| Note: this code works only on ConEmu terminals, and conflicts with push a notification code on iTerm2. | |
| </summary> | |
| <remarks> | |
| <see href="https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC">ConEmu specific OSC codes.</see><br/> | |
| <see href="https://iterm2.com/documentation-escape-codes.html">iTerm2 proprietary escape codes.</see> | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Logging.TerminalLogger.AnsiCodes.SetCursorHorizontal(System.Int32)"> | |
| <summary> | |
| Moves cursor to the specified column, or the rightmost column if <paramref name="column"/> is greater than the width of the terminal. | |
| </summary> | |
| <param name="column">Column index.</param> | |
| <returns>Control codes to set the desired position.</returns> | |
| </member> | |
| <member name="T:Microsoft.Build.Logging.TerminalLogger.TerminalColor"> | |
| <summary> | |
| Enumerates the text colors supported by VT100 terminal. | |
| </summary> | |
| </member> | |
| <member name="T:Microsoft.Build.Eventing.MSBuildEventSource"> | |
| <summary> | |
| This captures information of how various key methods of building with MSBuild ran. | |
| </summary> | |
| <remarks> | |
| Changes to existing event method signatures will not be reflected unless you update the <see cref="P:System.Diagnostics.Tracing.EventAttribute.Version" /> property or assign a new event ID. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Eventing.MSBuildEventSource.Keywords.All"> | |
| <summary> | |
| Keyword applied to all MSBuild events. | |
| </summary> | |
| <remarks> | |
| Literally every event should define this. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Eventing.MSBuildEventSource.Keywords.PerformanceLog"> | |
| <summary> | |
| Keyword for events that should go in the text performance log when turned on. | |
| </summary> | |
| <remarks> | |
| This keyword should be applied only to events that are low-volume | |
| and likely to be useful to diagnose perf issues using the | |
| <see href="https://github.com/dotnet/msbuild/pull/5861">text perf log</see>. | |
| </remarks> | |
| </member> | |
| <member name="F:Microsoft.Build.Eventing.MSBuildEventSource.Log"> | |
| <summary> | |
| define the singleton instance of the event source | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.ApplyLazyItemOperationsStart(System.String)"> | |
| <summary> | |
| Call this method to notify listeners of information relevant to collecting a set of items, mutating them in a specified way, and saving the results. | |
| </summary> | |
| <param name="itemType">The type of the item being mutated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.ApplyLazyItemOperationsStop(System.String)"> | |
| <param name="itemType">The type of the item being mutated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.BuildStart"> | |
| <summary> | |
| Call this method to notify listeners of information relevant to the setup for a BuildManager to receive build requests. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.BuildProjectStart(System.String)"> | |
| <summary> | |
| Call this method to notify listeners of information of how a project file built. | |
| <param name="projectPath">Filename of the project being built.</param> | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.BuildProjectStop(System.String,System.String)"> | |
| <param name="projectPath">Filename of the project being built.</param> | |
| <param name="targets">Names of the targets that built.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluateConditionStart(System.String)"> | |
| <param name="condition">The condition being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluateConditionStop(System.String,System.Boolean)"> | |
| <param name="condition">The condition being evaluated.</param> | |
| <param name="result">The result of evaluating the condition.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluateStart(System.String)"> | |
| <summary> | |
| Call this method to notify listeners of how the project data was evaluated. | |
| </summary> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluateStop(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass0Start(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass0Stop(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass1Start(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass1Stop(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass2Start(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass2Stop(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass3Start(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass3Stop(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass4Start(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass4Stop(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass5Start(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.EvaluatePass5Stop(System.String)"> | |
| <param name="projectFile">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.ExpandGlobStart(System.String,System.String,System.String)"> | |
| <summary> | |
| Call this method to notify listeners of information relevant to identifying a list of files that correspond to an item with a wildcard. | |
| </summary> | |
| <param name="rootDirectory">Source of files to glob.</param> | |
| <param name="glob">Pattern, possibly with wildcard(s) to be expanded.</param> | |
| <param name="excludedPatterns">Patterns not to expand.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.ExpandGlobStop(System.String,System.String,System.String)"> | |
| <param name="rootDirectory">Source of files to glob.</param> | |
| <param name="glob">Pattern, possibly with wildcard(s) to be expanded.</param> | |
| <param name="excludedPatterns">Patterns not to expand.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.LoadDocumentStart(System.String)"> | |
| <summary> | |
| Call this method to notify listeners of timing related to loading an XmlDocumentWithLocation from a path. | |
| <param name="fullPath">Path to the document to load.</param> | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.LoadDocumentStop(System.String)"> | |
| <param name="fullPath">Path to the document to load.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.ParseStart(System.String)"> | |
| <summary> | |
| Call this method to notify listeners of profiling for the function that parses an XML document into a ProjectRootElement. | |
| </summary> | |
| <param name="projectFileName">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.ParseStop(System.String)"> | |
| <param name="projectFileName">Filename of the project being evaluated.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.RarRemoveReferencesMarkedForExclusionStart"> | |
| <summary> | |
| Call this method to notify listeners of profiling for the method that removes denylisted references from the reference table. It puts primary and dependency references in invalid file lists. | |
| </summary> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.SaveStart(System.String)"> | |
| <param name="fileLocation">Project file's location.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.SaveStop(System.String)"> | |
| <param name="fileLocation">Project file's location.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.TargetStart(System.String)"> | |
| <param name="targetName">The name of the target being executed.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.TargetStop(System.String)"> | |
| <param name="targetName">The name of the target being executed.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.MSBuildExeStart(System.String)"> | |
| <summary> | |
| Call this method to notify listeners of the start of a build as called from the command line. | |
| </summary> | |
| <param name="commandLine">The command line used to run MSBuild.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.MSBuildExeStop(System.String)"> | |
| <param name="commandLine">The command line used to run MSBuild.</param> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.ReusableStringBuilderFactoryStart(System.Int32,System.Int32,System.Int32,System.String)"> | |
| <remarks> | |
| This events are quite frequent so they are collected by Debug binaries only. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.ReusableStringBuilderFactoryStop(System.Int32,System.Int32,System.Int32,System.String)"> | |
| <remarks> | |
| This events are quite frequent so they are collected by Debug binaries only. | |
| </remarks> | |
| </member> | |
| <member name="M:Microsoft.Build.Eventing.MSBuildEventSource.ReusableStringBuilderFactoryUnbalanced(System.Int32,System.Int32)"> | |
| <remarks> | |
| As oppose to other ReusableStringBuilderFactory events this one is expected to happens very un-frequently | |
| and if it is seen more than 100x per build it might indicates wrong usage patterns resulting into degrading | |
| efficiency of ReusableStringBuilderFactory. Hence it is collected in release build as well. | |
| </remarks> | |
| </member> | |
| </members> | |
| </doc> | |