Microsoft.Build.Framework Provides methods for creating a segmented dictionary that is immutable; meaning it cannot be changed once it is created. Represents a segmented dictionary that is immutable; meaning it cannot be changed once it is created. There are different scenarios best for and others best for . In general, is applicable in scenarios most like the scenarios where is applicable, and is applicable in scenarios most like the scenarios where is applicable. The following table summarizes the performance characteristics of : Operation Complexity Complexity Comments Item O(1) O(log n) Directly index into the underlying segmented dictionary Add() O(n) O(log n) Requires creating a new segmented dictionary This type is backed by segmented arrays to avoid using the Large Object Heap without impacting algorithmic complexity. The type of the keys in the dictionary. The type of the values in the dictionary. This type has a documented contract of being exactly one reference-type field in size. Our own class depends on it, as well as others externally. IMPORTANT NOTICE FOR MAINTAINERS AND REVIEWERS: 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 in place simply by reassigning the field containing this struct. Therefore it is extremely important that ⚠⚠ Every member should only dereference this ONCE ⚠⚠. If a member needs to reference the field, that counts as a dereference of this. Calling other instance members (properties or methods) also counts as dereferencing this. Any member that needs to use this more than once must instead assign this 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. The immutable collection this builder is based on. The current mutable collection this builder is operating on. This field is initialized to a copy of the first time a change is made. The return value from the implementation of is . This is the return value for most instances of this enumerator. The return value from the implementation of is . This is the return value for instances of this enumerator created by the implementation in . Private helper class for use only by . Represents a segmented list that is immutable; meaning it cannot be changed once it is created. There are different scenarios best for and others best for . The following table summarizes the performance characteristics of : Operation Complexity Complexity Comments Item O(1) O(log n) Directly index into the underlying segmented list Add() Currently O(n), but could be O(1) with a relatively large constant O(log n) Currently requires creating a new segmented list, but could be modified to only clone the segments with changes Insert() O(n) O(log n) Requires creating a new segmented list and cloning all impacted segments This type is backed by segmented arrays to avoid using the Large Object Heap without impacting algorithmic complexity. The type of the value in the list. This type has a documented contract of being exactly one reference-type field in size. Our own class depends on it, as well as others externally. IMPORTANT NOTICE FOR MAINTAINERS AND REVIEWERS: 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 in place simply by reassigning the field containing this struct. Therefore it is extremely important that ⚠⚠ Every member should only dereference this ONCE ⚠⚠. If a member needs to reference the field, that counts as a dereference of this. Calling other instance members (properties or methods) also counts as dereferencing this. Any member that needs to use this more than once must instead assign this 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. The immutable collection this builder is based on. Private helper class for use only by . The immutable collection this builder is based on. The current mutable collection this builder is operating on. This field is initialized to a copy of the first time a change is made. Swaps the values in the two references if the first is greater than the second. Swaps the values in the two references, regardless of whether the two references are the same. Helper methods for use in array/span sorting routines. Returns the integer (floor) log of the specified value, base 2. Note that by convention, input value 0 returns 0 since Log(0) is undefined. Does not directly use any hardware intrinsics, nor does it incur branching. The value. Returns approximate reciprocal of the divisor: ceil(2**64 / divisor). This should only be used on 64-bit. Performs a mod operation using the multiplier pre-computed with . 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. Provides static methods to invoke members on value types that explicitly implement the member. 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. Provides static methods to invoke members on value types that explicitly implement the member. 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. Provides static methods to invoke members on value types that explicitly implement the member. 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. Provides static methods to invoke members on value types that explicitly implement the member. 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. Provides static methods to invoke members on value types that explicitly implement the member. 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. Used internally to control behavior of insertion into a or . The default insertion behavior. Specifies that an existing entry with the same key should be overwritten if encountered. Specifies that if an existing entry with the same key is encountered, an exception should be thrown. Returns a by-ref to type that is a null reference. Returns if a given by-ref to type is a null reference. This check is conceptually similar to (void*)(&source) == nullptr. A combination of and . Calculates the maximum number of elements of size which can fit into an array which has the following characteristics: The array can be allocated in the small object heap. The array length is a power of 2. The size of the elements in the array. The segment size to use for small object heap segmented arrays. Calculates a shift which can be applied to an absolute index to get the page index within a segmented array. The number of elements in each page of the segmented array. Must be a power of 2. The shift to apply to the absolute index to get the page index within a segmented array. Calculates a mask, which can be applied to an absolute index to get the index within a page of a segmented array. The number of elements in each page of the segmented array. Must be a power of 2. The bit mask to obtain the index within a page from an absolute index within a segmented array. 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. The type of value stored by the list. The variable or field to be changed, which may be accessed by multiple threads. 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. if the location's value is changed by applying the result of the function; otherwise, if the location's value remained the same because the last invocation of returned the existing value. 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. The type of value stored by the list. The type of argument passed to the . The variable or field to be changed, which may be accessed by multiple threads. 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. The argument to pass to . if the location's value is changed by applying the result of the function; otherwise, if the location's value remained the same because the last invocation of returned the existing value. Assigns a field or variable containing an immutable list to the specified value and returns the previous value. The type of value stored by the list. The field or local variable to change. The new value to assign. The prior value at the specified . 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. The type of value stored by the list. The field or local variable to change. The new value to assign. The value to check equality for before assigning. The prior value at the specified . Assigns a field or variable containing an immutable list to the specified value if it is has not yet been initialized. The type of value stored by the list. The field or local variable to change. The new value to assign. if the field was assigned the specified value; otherwise, if it was previously initialized. 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. The type of key stored by the dictionary. The type of value stored by the dictionary. The variable or field to be changed, which may be accessed by multiple threads. 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. if the location's value is changed by applying the result of the function; otherwise, if the location's value remained the same because the last invocation of returned the existing value. 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. The type of key stored by the dictionary. The type of value stored by the dictionary. The type of argument passed to the . The variable or field to be changed, which may be accessed by multiple threads. 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. The argument to pass to . if the location's value is changed by applying the result of the function; otherwise, if the location's value remained the same because the last invocation of returned the existing value. Assigns a field or variable containing an immutable dictionary to the specified value and returns the previous value. The type of key stored by the dictionary. The type of value stored by the dictionary. The field or local variable to change. The new value to assign. The prior value at the specified . 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. The type of key stored by the dictionary. The type of value stored by the dictionary. The field or local variable to change. The new value to assign. The value to check equality for before assigning. The prior value at the specified . Assigns a field or variable containing an immutable dictionary to the specified value if it is has not yet been initialized. The type of key stored by the dictionary. The type of value stored by the dictionary. The field or local variable to change. The new value to assign. if the field was assigned the specified value; otherwise, if it was previously initialized. 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 T[]. The implementation of this collection uses segmented arrays to avoid placing objects on the Large Object Heap. The type of elements stored in the array. The number of elements in each page of the segmented array of type . The segment size is calculated according to , performs the IL operation defined by . ECMA-335 defines this operation with the following note: sizeof 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 sizeof bytes apart. The bit shift to apply to an array index to get the page index within . The bit mask to apply to an array index to get the index within a page of . Represents a collection of keys and values. This collection has the same performance characteristics as , but uses segmented arrays to avoid allocations in the Large Object Heap. The type of the keys in the dictionary. The type of the values in the dictionary. doesn't devirtualize on .NET Framework, so we always ensure is initialized to a non- value. Ensures that the dictionary can hold up to 'capacity' entries without any further expansion of its backing storage Sets the capacity of this dictionary to what it would be if it had been originally initialized with all its entries 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(); Sets the capacity of this dictionary to hold up 'capacity' entries without any further expansion of its backing storage This method can be used to minimize the memory overhead once it is known that no new elements will be added. 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. Represents a strongly typed list of objects that can be accessed by index. Provides methods to search, sort, and manipulate lists. This collection has the same performance characteristics as , but uses segmented arrays to avoid allocations in the Large Object Heap. The type of elements in the list. Destination array is not long enough to copy all the items in the collection. Check array index and length. Hashtable's capacity overflowed and went negative. Check load factor, capacity and the current size of the table. The given key '{0}' was not present in the dictionary. Destination array was not long enough. Check the destination index, length, and the array's lower bounds. Source array was not long enough. Check the source index, length, and the array's lower bounds. The lower bound of target array must be zero. Only single dimensional arrays are supported for the requested action. The value "{0}" is not of type "{1}" and cannot be used in this generic collection. An item with the same key has already been added. Key: {0} Target array type is not compatible with the type of items in the collection. 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. Number was less than the array's lower bound in the first dimension. Larger than collection size. Count must be positive and count must refer to a location within the string/array/collection. Index was out of range. Must be non-negative and less than the size of the collection. Index must be within the bounds of the List. Non-negative number required. capacity was less than the current size. 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. Collection was modified; enumeration operation may not execute. Enumeration has either not started or has already finished. Failed to compare two elements in the array. Mutating a key collection derived from a dictionary is not allowed. Mutating a value collection derived from a dictionary is not allowed. The specified arrays must have the same number of dimensions. Collection was of a fixed size. Object is not a array with the same number of elements as the array to compare it to. 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}'. Cannot find the old value This structure is used to return the result of the build and the target outputs. Did the build pass or fail Target outputs by project The constructor takes the result of the build and a list of the target outputs per project Did the build pass or fail. True means the build succeeded, False means the build failed. Outputs of the targets per project. Class to encapsulate state that was stored in BuildEnvironmentHelper. This should be deleted when BuildEnvironmentHelper can be moved into Framework. Arguments for error events Subcategory of the error Error code File name The project which issued the event Line number Column number End line number End column number A link pointing to more information about the error This constructor allows all event data to be initialized event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender This constructor which allows a timestamp to be set event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender Timestamp when event was created This constructor which allows a timestamp to be set event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender Timestamp when event was created message arguments This constructor which allows a timestamp to be set event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword A link pointing to more information about the error name of event sender Timestamp when event was created message arguments Default constructor The custom sub-type of the event. Code associated with event. File associated with event. The project file which issued this event. Line number of interest in associated file. Column number of interest in associated file. Ending line number of interest in associated file. Ending column number of interest in associated file. A link pointing to more information about the error. Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes to a stream through a binary writer Binary reader which the object will be deserialized from The version of the runtime the message packet was created from This class encapsulates the default data associated with build events. It is intended to be extended/sub-classed. Message. Volatile because it may be updated lock-free after construction. Help keyword Sender name Timestamp Thread id Build event context Default constructor This constructor allows all event data to be initialized text message help keyword name of event sender This constructor allows all event data to be initialized while providing a custom timestamp. text message help keyword name of event sender TimeStamp of when the event was created The time when event was raised. Exposes the private field to derived types. Used for serialization. Avoids the side effects of calling the getter. The thread that raised event. Text of event. Exposes the underlying message field without side-effects. Used for serialization. Like but returns a formatted message string if available. Used for serialization. Custom help keyword associated with event. Name of the object sending this event. Event contextual information for the build event argument Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into The message to write to the stream. Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from 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? Run after the object has been deserialized 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. Shortcut method to mimic the original logic of creating the formatted strings. Name of the resource string. Optional list of arguments to pass to the formatted string. The concatenated formatted string. Will provide location information for an event, this is especially needed in a multi processor environment Node event was in Target event was in The node-unique project request context the event was in Id of the task the event was caused from The id of the project instance to which this event refers. The id of the submission. The id of the evaluation This is the original constructor. No one should ever use this except internally for backward compatibility. Constructs a BuildEventContext with a specified project instance id. Constructs a BuildEventContext with a specific submission id Constructs a BuildEventContext Returns a default invalid BuildEventContext Retrieves the Evaluation id. NodeId where event took place Id of the target the event was in when the event was fired Retrieves the Project Context id. Retrieves the task id. Retrieves the project instance id. Retrieves the Submission id. Retrieves the BuildRequest id. Note that this is not the same as the global request id on a BuildRequest or BuildResult. Indicates an invalid project context identifier. Indicates an invalid task identifier. Indicates an invalid target identifier. Indicates an invalid node identifier. Indicates an invalid project instance identifier. Indicates an invalid submission identifier. Indicates an invalid evaluation identifier. Retrieves a hash code for this BuildEventContext. 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 Override == so the equals comparison using this operator will be the same as .Equals Left hand side operand Right hand side operand True if the object values are identical, false if they are not identical Override != so the equals comparison using this operator will be the same as ! Equals Left hand side operand Right hand side operand True if the object values are not identical, false if they are identical Verify the fields are identical BuildEventContext to compare to this instance True if the value fields are the same, false if otherwise Override this method to recover subtype-specific state from the remote exception. Override this method to provide subtype-specific state to be serialized. Remote exception internal data serving as the source for the exception deserialization. A catch-all type for remote exceptions that we don't know how to deserialize. This class represents the event arguments for build finished events. Whether the build succeeded Default constructor Constructor to initialize all parameters. Sender field cannot be set here and is assumed to be "MSBuild" text message help keyword True indicates a successful build Constructor which allows the timestamp to be set text message help keyword True indicates a successful build Timestamp when the event was created Constructor which allows the timestamp to be set text message help keyword True indicates a successful build Timestamp when the event was created message arguments Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from Succeeded is true if the build succeeded; false otherwise. This enumeration provides three levels of importance for messages. High importance, appears in less verbose logs Normal importance Low importance, appears in more verbose logs Arguments for message events Default constructor This constructor allows all event data to be initialized text message help keyword name of event sender importance of the message This constructor allows a timestamp to be set text message help keyword name of event sender importance of the message Timestamp when event was created This constructor allows a timestamp to be set text message help keyword name of event sender importance of the message Timestamp when event was created message arguments This constructor allows all event data to be initialized event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender importance of the message This constructor allows timestamp to be set event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender importance of the message custom timestamp for the event This constructor allows timestamp to be set event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender importance of the message custom timestamp for the event message arguments Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from Importance of the message The custom sub-type of the event. Code associated with event. File associated with event. Line number of interest in associated file. Column number of interest in associated file. Ending line number of interest in associated file. Ending column number of interest in associated file. The project which was building when the message was issued. Arguments for build started events. Default constructor Constructor to initialize all parameters. Sender field cannot be set here and is assumed to be "MSBuild" text message help keyword Constructor to initialize all parameters. Sender field cannot be set here and is assumed to be "MSBuild" text message help keyword A dictionary which lists the environment of the build when the build is started. Constructor to allow timestamp to be set text message help keyword Timestamp when the event was created Constructor to allow timestamp to be set text message help keyword Timestamp when the event was created message args The environment which is used at the start of the build Base class for build status events. This class is meant to be extended. 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 Default constructor This constructor allows event data to be initialized. text message help keyword name of event sender This constructor allows timestamp to be set text message help keyword name of event sender Timestamp when event was created This constructor allows timestamp to be set text message help keyword name of event sender Timestamp when event was created Optional arguments for formatting the message string. Arguments for warning events Default constructor This constructor allows all event data to be initialized event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender This constructor allows timestamp to be set event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender custom timestamp for the event This constructor allows timestamp to be set event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender custom timestamp for the event message arguments This constructor allows timestamp to be set event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword A link pointing to more information about the warning name of event sender custom timestamp for the event message arguments Serializes the Errorevent to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from The custom sub-type of the event. Code associated with event. File associated with event. Line number of interest in associated file. Column number of interest in associated file. Ending line number of interest in associated file. Ending column number of interest in associated file. The project which was building when the message was issued. A link pointing to more information about the warning. Coupled together with the MSBUILDDISABLEFEATURESFROMVERSION environment variable, this class acts as a way to make risky changes while giving customers an opt-out. 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 Special value indicating that all features behind all Change Waves should be enabled. The lowest wave in the current rotation of Change Waves. The highest wave in the current rotation of Change Waves. Checks the conditions for whether or not we want ApplyChangeWave to be called again. The current disabled wave. The status of how the disabled wave was set. Read from environment variable `MSBUILDDISABLEFEATURESFROMVERSION`, correct it if required, cache it and its ConversionState. Determines whether features behind the given wave are enabled. The version to compare. A bool indicating whether the change wave is enabled. Resets the state and value of the currently disabled version. Used for testing only. Arguments for critical message events. These always have High importance. This constructor allows all event data to be initialized event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender This constructor allows timestamp to be set event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender custom timestamp for the event This constructor allows timestamp to be set event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender custom timestamp for the event message arguments Default constructor Arguments for custom build events. [!CAUTION] In .NET 8 and later and Visual Studio 17.8 and later, this type is deprecated; instead use . For more information, see For recommended replacement, see . ]]> Default constructor This constructor allows event data to be initialized. text message help keyword name of sender This constructor allows event data to be initialized including timestamp. text message help keyword name of sender Timestamp when event was created This constructor allows event data to be initialized including timestamp. text message help keyword name of sender Timestamp when event was created Message arguments Exposes build engine functionality that was made available in newer versions of MSBuild. 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 . Initial version with LogsMessagesOfImportance() and IsTaskInputLoggingEnabled as the only exposed members. Gets an explicit version of this class. Must be incremented whenever new members are added. Derived classes should override the property to return the version actually being implemented. Returns if the given message importance is not guaranteed to be ignored by registered loggers. The importance to check. True if messages of the given importance should be logged, false if it's guaranteed that such messages would be ignored. Example: If we know that no logger is interested in , this method returns for and , and returns for . Returns if the build is configured to log all task inputs. This is a performance optimization allowing tasks to skip expensive double-logging. Arguments for the environment variable read event. Initializes an instance of the EnvironmentVariableReadEventArgs class. Initializes an instance of the EnvironmentVariableReadEventArgs class. The name of the environment variable that was read. The value of the environment variable that was read. Help keyword. The name of the sender of the event. The importance of the message. The name of the environment variable that was read. 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. 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. The value of the argument. Parameter that should not be null. Throws InternalErrorException. This is only for situations that would mean that there is a bug in MSBuild itself. Generic custom error events including extended data for event enriching. Extended data are implemented by Default constructor. Used for deserialization. This constructor specifies only type of extended data. Type of . This constructor allows all event data to be initialized Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender This constructor which allows a timestamp to be set Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender Timestamp when event was created This constructor which allows a timestamp to be set Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender Timestamp when event was created message arguments This constructor which allows a timestamp to be set Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword A link pointing to more information about the error name of event sender Timestamp when event was created message arguments Generic custom build events including extended data for event enriching. Extended data are implemented by Default constructor. Used for deserialization. This constructor specifies only type of extended data. Type of . This constructor allows all event data to be initialized Type of . text message help keyword name of event sender importance of the message This constructor allows a timestamp to be set Type of . text message help keyword name of event sender importance of the message Timestamp when event was created This constructor allows a timestamp to be set Type of . text message help keyword name of event sender importance of the message Timestamp when event was created message arguments This constructor allows all event data to be initialized Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender importance of the message This constructor which allows a timestamp to be set Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender importance of the message Timestamp when event was created This constructor which allows a timestamp to be set Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender importance of the message Timestamp when event was created message arguments Generic custom warning events including extended data for event enriching. Extended data are implemented by Default constructor. Used for deserialization. This constructor specifies only type of extended data. Type of . This constructor allows all event data to be initialized Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender This constructor which allows a timestamp to be set Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender Timestamp when event was created This constructor which allows a timestamp to be set Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender Timestamp when event was created message arguments This constructor which allows a timestamp to be set Type of . event sub-category event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword A link pointing to more information about the error name of event sender Timestamp when event was created message arguments Critical message events arguments including extended data for event enriching. Extended data are implemented by This constructor allows all event data to be initialized Type of . event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender This constructor allows timestamp to be set Type of . event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender custom timestamp for the event This constructor allows timestamp to be set Type of . event subcategory event code file associated with the event line number (0 if not applicable) column number (0 if not applicable) end line number (0 if not applicable) end column number (0 if not applicable) text message help keyword name of event sender custom timestamp for the event message arguments Default constructor. Used for deserialization. This constructor specifies only type of extended data. Type of . Generic custom event. Extended data are implemented by This constructor allows event data to be initialized. This constructor allows event data to be initialized. Type of . This constructor allows event data to be initialized. Type of . text message help keyword name of sender This constructor allows event data to be initialized including timestamp. Type of . text message help keyword name of sender Timestamp when event was created This constructor allows event data to be initialized including timestamp. Type of . text message help keyword name of sender Timestamp when event was created Message arguments Arguments for external project finished events Default constructor Useful constructor text message help keyword name of the object sending this event project name true indicates project built successfully Useful constructor including the ability to set the timestamp text message help keyword name of the object sending this event project name true indicates project built successfully Timestamp when event was created Project name True if project built successfully, false otherwise Arguments for external project started events Default constructor Useful constructor text message help keyword name of the object sending this event project name targets we are going to build (empty indicates default targets) Useful constructor, including the ability to set the timestamp of the event text message help keyword name of the object sending this event project name targets we are going to build (empty indicates default targets) Timestamp when the event was created Project name 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. The status of a feature. The feature availability is not determined. The feature is available. The feature is not available. The feature is in preview, subject to change API or behavior between releases. This class is used to manage features. Checks if a feature is available or not. The name of the feature. A feature status . Attempts to classify project files for various purposes such as safety and performance. Callers of this class are responsible to respect current OS path string comparison. The term "project files" refers to the root project file (e.g. MyProject.csproj) and any other .props and .targets files it imports. Classifications provided are: 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. StringComparison used for comparing paths on current OS. TODO: Replace RuntimeInformation.IsOSPlatform(OSPlatform.Linux) by NativeMethodsShared.OSUsesCaseSensitivePaths once it is moved out from Shared Single, static instance of shared file FileClassifier for member. Serves purpose of thread safe set of known immutable directories. Although 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. Copy on write snapshot of . Creates default FileClassifier which following immutable folders: Classifications provided are: Program Files\Reference Assemblies\Microsoft Program Files (x86)\Reference Assemblies\Microsoft Visual Studio installation root Individual projects NuGet folders are added during project build by calling Shared singleton instance. Try add path into set of known immutable paths. Files under any of these folders are considered non-modifiable. This value is used by . Files in the NuGet package cache are not expected to change over time, once they are created. Gets whether a file is expected to not be modified in place on disk once it has been created. The path to the file to test. if the file is non-modifiable, otherwise . Arguments for the generated file used event Initializes a new instance of the class. The file path relative to the current project. The content of the file. This interface exposes functionality on the build engine that is required for task authoring. 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. Details of event to raise. 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. Details of event to raise. 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. Details of event to raise. 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. Details of event to raise. Returns true if the ContinueOnError flag was set to true for this particular task in the project file. Retrieves the line number of the task node within the project file that called it. Retrieves the line number of the task node within the project file that called it. Returns the full path to the project file that contained the call to this task. 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. 1) it is acceptable to pass null for both targetNames and targetOutputs 2) if no targets are specified, the default targets are built 3) target outputs are returned as ITaskItem arrays indexed by target name The project to build. The targets in the project to build (can be null). A hash table of additional global properties to apply to the child project (can be null). The key and value should both be strings. The outputs of each specified target (can be null). true, if build was successful This interface extends to provide a reference to the class. Future engine API should be added to the class as opposed to introducing yet another version of the IBuildEngine interface. Returns the new build engine interface. This interface extends IBuildEngine to provide a method allowing building project files in parallel. 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. 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. 1) it is acceptable to pass null for both targetNames and targetOutputs 2) if no targets are specified, the default targets are built 3) target outputs are returned as ITaskItem arrays indexed by target name The project to build. The targets in the project to build (can be null). A hash table of additional global properties to apply to the child project (can be null). The key and value should both be strings. The outputs of each specified target (can be null). A tools version recognized by the Engine that will be used during this build (can be null). true, if build was successful 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. 1) it is acceptable to pass null for both targetNames and targetOutputs 2) if no targets are specified, the default targets are built 3) target outputs are returned as ITaskItem arrays indexed by target name The project to build. The targets in the project to build (can be null). 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. The outputs of each specified target (can be null). A tools version recognized by the Engine that will be used during this build (can be null). 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 If true the project will be unloaded once the operation is completed true, if build was successful This interface extends IBuildEngine to provide a method allowing building project files in parallel. 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. 1) it is acceptable to pass null for both targetNames and targetOutputs 2) if no targets are specified, the default targets are built The project to build. The targets in the project to build (can be null). 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. A list of global properties which should be removed. A tools version recognized by the Engine that will be used during this build (can be null). Should the target outputs be returned in the BuildEngineResult Returns a structure containing the success or failure of the build and the target outputs by project. 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. Waits to reacquire control after yielding. Defines the lifetime of a registered task object. The registered object will be disposed when the build ends. The registered object will be disposed when the AppDomain is unloaded. The AppDomain to which this refers is the one in which MSBuild was launched, not the one in which the Task was launched. This interface extends IBuildEngine to provide a mechanism allowing tasks to share data between task invocations. Registers an object with the system that will be disposed of at some specified time in the future. The key used to retrieve the object. The object to be held for later disposal. The lifetime of the object. The object may be disposed earlier that the requested time if MSBuild needs to reclaim memory. 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 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. 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 is set to true. If the object implements IDisposable, IDisposable.Dispose will be invoked on the object before discarding it. Retrieves a previously registered task object stored with the specified key. The key used to retrieve the object. The lifetime of the object. The registered object, or null is there is no object registered under that key or the object has been discarded through early collection. Unregisters a previously-registered task object. The key used to retrieve the object. The lifetime of the object. The registered object, or null is there is no object registered under that key or the object has been discarded through early collection. This interface extends IBuildEngine to log telemetry. Logs telemetry. The event name. The event properties. This interface extends to allow tasks to get the current project's global properties. Gets the global properties for the current project. An containing the global properties of the current project. This interface extends to allow tasks to set whether they want to log an error when a task returns without logging an error. This interface extends to let tasks know if a warning they are about to log will be converted into an error. Determines whether the logging service will convert the specified warning code into an error. The warning code to check. A boolean to determine whether the warning should be treated as an error. This interface extends to provide resource management API to tasks. If a task launches multiple parallel processes, it should ask how many cores it can use. The number of cores a task can potentially use. The number of cores a task is allowed to use. 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. Number of cores no longer in use. Interface for tasks which can be cancelled. Instructs the task to exit as soon as possible, or to immediately exit if Execute is invoked after this method. Cancel() may be called at any time after the task has been instantiated, even before is called. Cancel calls may come in from any thread. The implementation of this method should not block indefinitely. This interface is used to forward events to another loggers This method is called by the node loggers to forward the events to central logger Type of handler for MessageRaised events Type of handler for ErrorRaised events Type of handler for WarningRaised events Type of handler for CustomEventRaised events Type of handler for BuildStartedEvent events Type of handler for BuildFinishedEvent events Type of handler for ProjectStarted events Type of handler for ProjectFinished events Type of handler for TargetStarted events Type of handler for TargetFinished events Type of handler for TaskStarted events Type of handler for TaskFinished events Type of handler for BuildStatus events Type of handler for AnyEventRaised events This interface defines the events raised by the build engine. Loggers use this interface to subscribe to the events they are interested in receiving. this event is raised to log a message this event is raised to log an error this event is raised to log a warning this event is raised to log the start of a build this event is raised to log the end of a build this event is raised to log the start of a project build this event is raised to log the end of a project build this event is raised to log the start of a target build this event is raised to log the end of a target build this event is raised to log the start of task execution this event is raised to log the end of task execution this event is raised to log custom events this event is raised to log any build status event this event is raised to log any build event. These events do not include telemetry. To receive telemetry, you must attach to the event. Helper methods for interface. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Helper method ensuring single deduplicated subscription to the event. Handler to the event. If this handler is already subscribed, single subscription will be ensured. Type of handler for TelemetryLogged events This interface defines the events raised by the build engine. Loggers use this interface to subscribe to the events they are interested in receiving. this event is raised to when telemetry is logged. This interface defines the events raised by the build engine. Loggers use this interface to subscribe to the events they are interested in receiving. Should evaluation events include generated metaprojects? Should evaluation events include profiling information? Should task events include task inputs? This interface defines the events raised by the build engine. Loggers use this interface to subscribe to the events they are interested in receiving. Determines whether properties and items should be logged on instead of . 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. Unique string identifying type of extended data so receiver side knows how to interpret, deserialize and handle . Metadata of . Example usage: - data which needed in custom code to properly routing this message without interpreting/deserializing . - simple extended data can be transferred in form of dictionary key-value per one extended property. 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... 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. This property is set by the build engine to allow a node loggers to forward messages to the central logger This property is set by the build engine or node to inform the forwarding logger which node it is running on An interface implemented by tasks that are generated by ITaskFactory instances. Sets a value on a property of this task instance. The property to set. The value to set. The caller is responsible to type-coerce this value to match the property's . All exceptions from this method will be caught in the taskExecution host and logged as a fatal task error Gets the property value. The property to get. The value of the property, the value's type will match the type given by . 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 Interface for tasks which is supports incrementality. The tasks implementing this interface should return false to stop the build when in is true and task is not fully incremental. Try to provide helpful information to diagnose incremental behavior. Set by MSBuild when Question flag is used. Enumeration of the levels of detail of an event log. 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 The most minimal output Relatively little output Standard output. This should be the default if verbosity level is not set Relatively verbose, but not exhaustive The most verbose and informative verbosity 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. 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. The verbosity level. 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. The parameter string (can be null). Called by the build engine to allow loggers to subscribe to the events they desire. The events available to loggers. Called by the build engine to allow loggers to release any resources they may have allocated at initialization time, or during the build. Provides a way to efficiently enumerate item metadata 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. Sets the given metadata. The operation is equivalent to calling 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. The metadata to set. The keys are assumed to be unique and values are assumed to be escaped. Caching 'Last Write File Utc' times for Immutable files . Cache is add only. It does not updates already existing cached items. Shared singleton instance Try get 'Last Write File Utc' time of particular file. if record exists Try Add 'Last Write File Utc' time of particular file into cache. 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. Initializes the current instance. 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. Default constructor. SHOULD ONLY BE CALLED BY DESERIALIZER. SUPPLY A MESSAGE INSTEAD. Creates an instance of this exception using the given message. 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. 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. 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. Interface for exposing a ProjectElement to the appropriate loggers Gets the name of the associated element. Useful for display in some circumstances. The outer markup associated with this project element Provider of instances. Main design goal is for reusable String Builders and string builder pools. It is up to particular implementations to decide how to handle unbalanced releases. Get a of at least the specified capacity. The suggested starting size of this instance. A that may or may not be reused. It can be called any number of times; if a is in the cache then it will be returned and the cache emptied. Subsequent calls will return a new . Get a string and return its builder to the cache. Builder to cache (if it's not too big). The equivalent to 's contents. The StringBuilder should not be used after it has been released. 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. This property is set by the build engine to allow a task to call back into it. The interface on the build engine available to tasks. The build engine sets this property if the host IDE has associated a host object with this particular task. The host object instance (can be null). 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. true, if successful Interface that a task factory Instance should implement Gets the name of the factory. The name of the factory. Gets the type of the task this factory will instantiate. Implementations must return a value for this property. Initializes this factory for instantiating tasks with a particular inline task block. Name of the task. The parameter group. The task body. The task factory logging host. A value indicating whether initialization was successful. 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. The taskFactoryLoggingHost will log messages in the context of the target where the task is first used. Get the descriptions for all the task's parameters. A non-null array of property descriptions. Create an instance of the task to be used. The task factory logging host will log messages in the context of the task. The generated task, or null if the task failed to be created. Cleans up any context or state that may have been built up for a given task. The task to clean up. 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. Interface that a task factory Instance should implement if it wants to be able to use new UsingTask parameters such as Runtime and Architecture. 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. Name of the task. 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. The parameter group. The task body. The task factory logging host. A value indicating whether initialization was successful. 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. The taskFactoryLoggingHost will log messages in the context of the target where the task is first used. 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. The task factory logging host will log messages in the context of the task. 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. If a task factory implements ITaskFactory2, MSBuild will call this method instead of ITaskFactory.CreateTask. The generated task, or null if the task failed to be created. 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. This interface defines a project item that can be consumed and emitted by tasks. Gets or sets the item "specification" e.g. for disk-based items this would be the file path. This should be named "EvaluatedInclude" but that would be a breaking change to this interface. The item-spec string. Gets the names of all the metadata on the item. Includes the built-in metadata like "FullPath". The list of metadata names. Gets the number of pieces of metadata on the item. Includes both custom and built-in metadata. Count of pieces of metadata. Allows the values of metadata on the item to be queried. The name of the metadata to retrieve. The value of the specified metadata. Allows a piece of custom metadata to be set on the item. The name of the metadata to set. The metadata value. Allows the removal of custom metadata set on the item. The name of the metadata to remove. Allows custom metadata on the item to be copied to another item. 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 The item to copy metadata to. Get the collection of custom metadata. This does not include built-in metadata. 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. Dictionary of cloned metadata This interface adds escaping support to the ITaskItem interface. Gets or sets the item include value e.g. for disk-based items this would be the file path. Taking the opportunity to fix the property name, although this doesn't make it obvious it's an improvement on ItemSpec. Allows the values of metadata on the item to be queried. Taking the opportunity to fix the property name, although this doesn't make it obvious it's an improvement on GetMetadata. 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. Taking the opportunity to fix the property name, although this doesn't make it obvious it's an improvement on SetMetadata. ITaskItem2 implementation which returns a clone of the metadata on this object. Values returned are in their original escaped form. The cloned metadata, with values' escaping preserved. Provides a way to efficiently enumerate custom metadata of an item, without built-in metadata. TaskItem implementation to return metadata from WARNING: do NOT use List`1.AddRange to iterate over this collection. CopyOnWriteDictionary from Microsoft.Build.Utilities.v4.0.dll is broken. A non-null (but possibly empty) enumerable of item metadata. Stores strings for parts of a message delaying the formatting until it needs to be shown Stores the message arguments. Exposes the underlying arguments field to serializers. Exposes the formatted message string to serializers. This constructor allows all event data to be initialized. text message. help keyword. name of event sender. This constructor that allows message arguments that are lazily formatted. text message. help keyword. name of event sender. Timestamp when event was created. Message arguments. Default constructor. Gets the formatted message. Serializes to a stream through a binary writer. Binary writer which is attached to the stream the event will be serialized into. Deserializes from a stream through a binary reader. Binary reader which is attached to the stream the event will be deserialized from. The version of the runtime the message packet was created from 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 This method is thread-safe. The string to format. Optional arguments for formatting the given string. The formatted string. 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. Default constructor. 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. Default constructor. This constructor only exists to satisfy .NET coding guidelines. Use the rich constructor instead. Creates an instance of this exception using the specified error message. Message string Creates an instance of this exception using the specified error message and inner exception. Message string Inner exception. Can be null Creates an instance of this exception using rich error information. Message string Inner exception. Can be null Error code Help keyword for host IDE. Can be null Protected constructor used for (de)serialization. If we ever add new members to this class, we'll need to update this. Serialization info Streaming context 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. Serialization info Streaming context Gets the error code associated with this exception's message (not the inner exception). The error code string. Gets the F1-help keyword associated with this error, for the host IDE. The keyword string. Arguments for the metaproject generated event. Raw xml representing the metaproject. Initializes a new instance of the MetaprojectGeneratedEventArgs class. Default buffer size to use when dealing with the Windows API. Flags for CoWaitForMultipleHandles Exit when a handle is signaled. Exit when all handles are signaled AND a message is received. Exit when an RPC call is serviced. Processor architecture values Structure that contain information about the system on which we are running Wrap the intptr returned by OpenProcess in a safe handle. Contains information about the current state of both physical and virtual memory, including extended memory Initializes a new instance of the class. Size of the structure, in bytes. You must set this member before calling GlobalMemoryStatusEx. 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). Total size of physical memory, in bytes. Size of physical memory available, in bytes. Size of the committed memory limit, in bytes. This is physical memory plus the size of the page file, minus a small overhead. Size of available memory to commit, in bytes. The limit is ullTotalPageFile. Total size of the user mode portion of the virtual address space of the calling process, in bytes. Size of unreserved and uncommitted memory in the user mode portion of the virtual address space of the calling process, in bytes. Size of unreserved and uncommitted memory in the extended portion of the virtual address space of the calling process, in bytes. Contains information about a file or directory; used by GetFileAttributesEx. Contains the security descriptor for an object and specifies whether the handle retrieved by specifying this structure is inheritable. 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. Actual architecture of the system. Convert SYSTEM_INFO architecture values to the internal enum Read system info values 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 Gets the max path limit of the current OS. Cached value for MaxPath. Cached value for IsUnixLike (this method is called frequently during evaluation). Gets a flag indicating if we are running under a Unix-like system (Mac, Linux, etc.) Gets a flag indicating if we are running under Linux Gets a flag indicating if we are running under flavor of BSD (NetBSD, OpenBSD, FreeBSD) Gets a flag indicating if we are running under some version of Windows Gets a flag indicating if we are running under Mac OSX Gets a string for the current OS. This matches the OS env variable for Windows (Windows_NT). Framework named as presented to users (for example in version info). OS name that can be used for the msbuildExtensionsPathSearchPaths element for a toolset The base directory for all framework paths in Mono The directory of the current framework Gets the currently running framework path Gets the base directory of all Mono frameworks System information, initialized when required. Initially implemented as , but that's .NET 4+, and this is used in MSBuildTaskHost. Architecture getter Native architecture getter 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. Full path to the file in the filesystem The UTC last write time for the directory Takes the path and returns the short path Takes the path and returns a full path Retrieves the current global memory status. Get the last write time of the fullpath to the file. Full path to the file in the filesystem The last write time of the file, or DateTime.MinValue if the file does not exist. 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. Get the SafeFileHandle for a file, while skipping reparse points (going directly to target file). Full path to the file in the filesystem the SafeFileHandle for a file (target file in case of symlinks) Get the last write time of the content pointed to by a file path. Full path to the file in the filesystem The last write time of the file, or DateTime.MinValue if the file does not exist. 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. Did the HRESULT succeed Did the HRESULT Fail Given an error code, converts it to an HRESULT and throws the appropriate exception. Kills the specified process by id and all of its children recursively. Returns the parent process id for the specified process. Returns zero if it cannot be gotten for some reason. 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. Internal, optimized GetCurrentDirectory implementation that simply delegates to the native method Compare an unsafe char buffer with a to see if their contents are identical. The beginning of the char buffer. The length of the buffer. The string. True only if the contents of and the first characters in are identical. 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 Gets the fully qualified filename of the currently executing .exe. of the module for which we are finding the file name. The character buffer used to return the file name. The length of the buffer. 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. System.OperatingSystem static methods were added in net5.0. This class creates stand-in methods for net472 builds. Assumes only Windows is supported. 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. Default constructor. Assigns unique evaluation ids. Thread safe. Returns a unique evaluation id The id is guaranteed to be unique across all running processes. Additionally, it is monotonically increasing for callers on the same process id Evaluation main phases used by the profiler Order matters since the profiler pretty printer orders profiled items from top to bottom using the pass they belong to The kind of the evaluated location being tracked Represents a location for different evaluation elements tracked by the EvaluationProfiler. Default descriptions for locations that are used in case a description is not provided Constructs a generic evaluation location Used by serialization/deserialization purposes Constructs a generic evaluation location based on a (possibly null) parent Id. A unique Id gets assigned automatically Used by serialization/deserialization purposes Constructs a generic evaluation location with no parent. A unique Id gets assigned automatically Used by serialization/deserialization purposes An empty location, used as the starting instance. Result of profiling an evaluation Result of timing the evaluation of a given element at a given location Arguments for the project evaluation finished event. Initializes a new instance of the ProjectEvaluationFinishedEventArgs class. Initializes a new instance of the ProjectEvaluationFinishedEventArgs class. Gets or sets the full path of the project that started evaluation. Global properties used during this evaluation. Final set of properties produced by this evaluation. Final set of items produced by this evaluation. The result of profiling a project. Null if profiling is not turned on Arguments for the project evaluation started event. Initializes a new instance of the ProjectEvaluationStartedEventArgs class. Initializes a new instance of the ProjectEvaluationStartedEventArgs class. Gets or sets the full path of the project that started evaluation. Arguments for project finished events Default constructor This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". text message help keyword name of the project true indicates project built successfully This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". This constructor allows the timestamp to be set as well text message help keyword name of the project true indicates project built successfully Timestamp when the event was created Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from Project name True if project built successfully, false otherwise Arguments for the project imported event. Initializes a new instance of the ProjectImportedEventArgs class. Initializes a new instance of the ProjectImportedEventArgs class. Gets or sets the original value of the Project attribute. Gets or sets the full path to the project file that was imported. Will be null if the import statement was a glob and no files matched, or the condition (if any) evaluated to false. Gets or sets if this import was ignored. Ignoring imports is controlled by ProjectLoadSettings. 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. Arguments for project started events Indicates an invalid project identifier. Default constructor This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". text message help keyword project name targets we are going to build (empty indicates default targets) list of properties list of items This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". project id text message help keyword project name targets we are going to build (empty indicates default targets) list of properties list of items event context info for the parent project This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". project id text message help keyword project name targets we are going to build (empty indicates default targets) list of properties list of items event context info for the parent project An containing global properties. The tools version. This constructor allows event data to be initialized. Also the timestamp can be set Sender is assumed to be "MSBuild". text message help keyword project name targets we are going to build (empty indicates default targets) list of properties list of items The of the event. This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". project id text message help keyword project name targets we are going to build (empty indicates default targets) list of properties list of items event context info for the parent project The of the event. Gets the identifier of the project. Event context information, where the event was fired from in terms of the build location The name of the project file Project name Targets that we will build in the project Targets that we will build in the project Gets the set of global properties used to evaluate this project. Gets the set of global properties used to evaluate this project. Gets the tools version used to evaluate this project. List of properties in this project. This is a live, read-only list. List of items in this project. This is a live, read-only list. Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from The argument for a property initial value set event. Creates an instance of the class. Creates an instance of the class. The name of the property. The value of the property. The source of the property. The message of the property. The help keyword. The sender name of the event. The importance of the message. The name of the property. The value of the property. The source of the property. The argument for a property reassignment event. Creates an instance of the PropertyReassignmentEventArgs class. Creates an instance of the PropertyReassignmentEventArgs class. The name of the property whose value was reassigned. The previous value of the reassigned property. The new value of the reassigned property. The location of the reassignment. The message of the reassignment event. The help keyword of the reassignment. The sender name of the reassignment event. The importance of the message. The name of the property whose value was reassigned. The previous value of the reassigned property. The new value of the reassigned property. The location of the reassignment. 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. Default constructor. 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 Constructor taking a version, such as "v2.0". Returns the runtime version the attribute was constructed with, e.g., "v2.0" Arguments for the response file used event Initialize a new instance of the ResponseFileUsedEventArgs class. A StringBuilder lookalike that reuses its internal storage. This class is being deprecated in favor of SpanBasedStringBuilder in StringTools. Avoid adding more uses. Captured string builder. Capacity of borrowed string builder at the time of borrowing. Capacity to initialize the builder with. Create a new builder, under the covers wrapping a reused one. The length of the target. Convert to a string. Dispose, indicating you are done with this builder. Append a character. Append a string. Append a substring. Remove a substring. Grab a backing builder if necessary. A utility class that mediates access to a shared string builder. If this shared builder is highly contended, this class could add a second one and try both in turn. 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. 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 This constant might looks huge, but rather than lowering this constant, we shall focus on eliminating code which requires creating such huge strings. The shared builder. Obtains a string builder which may or may not already have been used. Never returns null. Returns the shared builder for the next caller to use. ** CALLERS, DO NOT USE THE BUILDER AFTER RELEASING IT HERE! ** This attribute is used to mark a task class as explicitly not being required to run in the STA for COM. Default constructor. This attribute is used to mark a task class as being required to run in a Single Threaded Apartment for COM. Default constructor. An abstract interface class to providing real-time logging and status while resolving an SDK. Log a build message to MSBuild. Message string. Optional message importances. Default to low. Represents a software development kit (SDK) that is referenced in a <Project /> or <Import /> element. Initializes a new instance of the SdkReference class. The name of the SDK. The version of the SDK. Minimum SDK version required by the project. Gets the name of the SDK. Gets the version of the SDK. 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. Indicates whether the current object is equal to another object of the same type. An object to compare with this object. if the current object is equal to the parameter; otherwise, . Attempts to parse the specified string as a . The expected format is: SDK, SDK/Version, or SDK/min=MinimumVersion Values are not required to specify a version or MinimumVersion. An SDK name and version to parse in the format "SDK/Version,min=MinimumVersion". A parsed if the specified value is a valid SDK name. true if the SDK name was successfully parsed, otherwise false. An abstract interface for classes that can resolve a Software Development Kit (SDK). Gets the name of the to be displayed in build output log. Gets the self-described resolution priority order. MSBuild will sort resolvers by this value. Resolves the specified SDK reference. A containing the referenced SDKs be resolved. Context for resolving the SDK. Factory class to create an An containing the resolved SDKs or associated error / reason the SDK could not be resolved. Return if the resolver is not applicable for a particular . Note: You must use to return a result. Context used by an to resolve an SDK. Gets a value indicating if the resolver is allowed to be interactive. Gets a value indicating if the resolver is running in Visual Studio. Logger to log real-time messages back to MSBuild. Path to the project file being built. Path to the solution file being built, if known. May be null. Version of MSBuild currently running. Gets or sets any custom state for current build. This allows resolvers to maintain state between resolutions. This property is not thread-safe. An abstract interface class to indicate SDK resolver success or failure. [!NOTE] > Use to create instances of this class. Do not inherit from this class. ]]> Indicates the resolution was successful. Resolved path to the SDK. Null if == false 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 == false Additional resolved SDK paths beyond the one specified in This allows an SDK resolver to return multiple SDK paths, which will all be imported. Properties that should be added to the evaluation. This allows an SDK resolver to provide information to the build Items that should be added to the evaluation. This allows an SDK resolver to provide information to the build The Sdk reference An abstract interface class provided to to create an object indicating success / failure. Create an object indicating success resolving the SDK. Path to the SDK. Version of the SDK that was resolved. Optional warnings to display during resolution. Create an object indicating success resolving the SDK. Path to the SDK. Version of the SDK that was resolved. Properties to set in the evaluation Items to add to the evaluation Optional warnings to display during resolution. Create an object indicating success. 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). SDK paths which should be imported SDK version which should be imported Properties to set in the evaluation Items to add to the evaluation Optional warnings to display during resolution. Create an object indicating failure resolving the SDK. Errors / reasons the SDK could not be resolved. Will be logged as a build error if no other SdkResolvers were able to indicate success. The value of an item and any associated metadata to be added by an SDK resolver. See Creates an The value (itemspec) for the item A dictionary of item metadata. This should be created with for the comparer. A cached reusable instance of StringBuilder. An optimization that reduces the number of instances of constructed and collected. Get a of at least the specified capacity. The suggested starting size of this instance. A that may or may not be reused. It can be called any number of times; if a is in the cache then it will be returned and the cache emptied. Subsequent calls will return a new . The instance is cached in Thread Local Storage and so there is one per thread. 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. The to cache. Likely returned from . 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. Get a string and return its builder to the cache. Builder to cache (if it's not too big). The equivalent to 's contents. Convenience method equivalent to calling followed by . The reason that a target was built by its parent target. This wasn't built on because of a parent. The target was part of the parent's BeforeTargets list. The target was part of the parent's DependsOn list. The target was part of the parent's AfterTargets list. Arguments for target finished events Default constructor This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". text message help keyword target name project file file in which the target is defined true if target built successfully This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". text message help keyword target name project file file in which the target is defined true if target built successfully Target output items for the target. If batching will be null for everything except for the last target in the batch This constructor allows event data to be initialized including the timestamp when the event was created. Sender is assumed to be "MSBuild". text message help keyword target name project file file in which the target is defined true if target built successfully Timestamp when the event was created An containing the outputs of the target. Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from Target name True if target built successfully, false otherwise Project file associated with event. File where this target was declared. Target outputs A reason why a target was skipped. The target was not skipped or the skip reason was unknown. The target previously built successfully. The target previously built unsuccessfully. All the target outputs were up-to-date with respect to their inputs. The condition on the target was evaluated as false. Arguments for the target skipped event. Initializes a new instance of the TargetSkippedEventArgs class. Initializes a new instance of the TargetSkippedEventArgs class. The reason why the target was skipped. Gets or sets the name of the target being skipped. Gets or sets the parent target of the target being skipped. File where this target was declared. Why the parent target built this target. Whether the target succeeded originally. describing the original build of the target, or null if not available. The condition expression on the target declaration. The value of the condition expression as it was evaluated. Arguments for target started events Default constructor This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". text message help keyword target name project file file in which the target is defined This constructor allows event data to be initialized including the timestamp when the event was created. text message help keyword target name project file file in which the target is defined The part of the target. Timestamp when the event was created This constructor allows event data to be initialized. text message help keyword target name project file file in which the target is defined The part of the target. The reason the parent built this target. Timestamp when the event was created Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from target name Target which caused this target to build Project file associated with event. File where this target was declared. Why this target was built by its parent. This class is used by tasks to log their command lines. This class extends 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. 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 Default (family) constructor. Creates an instance of this class for the given task command line. The command line used by a task to launch its underlying tool/executable. The name of the task raising this event. Importance of command line -- controls whether the command line will be displayed by less verbose loggers. Creates an instance of this class for the given task command line. This constructor allows the timestamp to be set The command line used by a task to launch its underlying tool/executable. The name of the task raising this event. Importance of command line -- controls whether the command line will be displayed by less verbose loggers. Timestamp when the event was created Gets the task command line associated with this event. Gets the name of the task that raised this event. Arguments for task finished events Default constructor This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". text message help keyword project file file in which the task is defined task name true indicates task succeed This constructor allows event data to be initialized and the timestamp to be set Sender is assumed to be "MSBuild". text message help keyword project file file in which the task is defined task name true indicates task succeed Timestamp when event was created Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes the Errorevent from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from Task Name True if target built successfully, false otherwise Project file associated with event. MSBuild file where this task was defined. Lightweight specialized implementation of only used for deserializing items. The goal is to minimize overhead when representing deserialized items. Used by node packet translator and binary logger. Clone the task item and all metadata to create a snapshot An to clone This class is used by tasks to log their parameters (input, output). The intrinsic ItemGroupIntrinsicTask to add or remove items also uses this class. Creates an instance of this class for the given task parameter. The 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. Note that the current implementation never runs and is provided merely as a safeguard in case MessageGetter isn't set for some reason. 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. Class which represents the parameter information from the using task as a strongly typed class. Encapsulates a list of parameters declared in the UsingTask Name of the parameter The actual type of the parameter True if the parameter is both an output and input parameter. False if the parameter is only an input parameter True if the parameter must be supplied to each invocation of the task. The type of the property Name of the property This task parameter is an output parameter (analogous to [Output] attribute) This task parameter is required (analogous to the [Required] attribute) This task parameter should be logged when LogTaskInputs is set. Defaults to true. When this task parameter is an item list, determines whether to log item metadata. Defaults to true. Whether the Log and LogItemMetadata properties have been assigned already. Arguments for task started events Default constructor This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". text message help keyword project file file in which the task is defined task name This constructor allows event data to be initialized. Sender is assumed to be "MSBuild". text message help keyword project file file in which the task is defined task name Timestamp when event was created Serializes to a stream through a binary writer Binary writer which is attached to the stream the event will be serialized into Deserializes the Errorevent from a stream through a binary reader Binary reader which is attached to the stream the event will be deserialized from The version of the runtime the message packet was created from Task name. Project file associated with event. MSBuild file where this task was defined. Line number of the task invocation in the project file Column number of the task invocation in the project file Arguments for telemetry events. Gets or sets the name of the event. Gets or sets a list of properties associated with the event. Telemetry of build. Time at which build have started. 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. Time at which inner build have started. 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. Time at which build have finished. Overall build success. Build Target. MSBuild server fallback reason. Either "ServerBusy", "ConnectionError" or null (no fallback). Version of MSBuild. Display version of the Engine suitable for display to a user. Path to project file. Host in which MSBuild build was executed. For example: "VS", "VSCode", "Azure DevOps", "GitHub Action", "CLI", ... State of MSBuild server process before this build. One of 'cold', 'hot', null (if not run as server) Framework name suitable for display to a user. Static class to help access and modify known telemetries. 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. Describes how logging was configured. True if terminal logger was used. 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 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 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 How was default behavior signaled: sdk -> from SDK DOTNET_CLI_CONFIGURE_MSBUILD_TERMINAL_LOGGER -> from environment variable msbuild -> MSBuild hardcoded default null -> unspecified True if console logger was used. Type of console logger: serial | parallel Verbosity of console logger: quiet | minimal | normal | detailed | diagnostic True if file logger was used. Type of file logger: serial | parallel Number of file loggers. Verbosity of file logger: quiet | minimal | normal | detailed | diagnostic True if binary logger was used. True if binary logger used default name i.e. no LogFile was specified. Gets or sets the name of the event. Fetches all derived type members wrapped in Dictionary which will be used to build . Represents toggleable features of the MSBuild engine Do not expand wildcards that match a certain pattern Cache file existence for the entire process Cache wildcard expansions for the entire process Enable restore first functionality in MSBuild.exe Allow the user to specify that two processes should not be communicating via an environment variable. Override property "MSBuildRuntimeType" to "Full", ignoring the actual runtime type of MSBuild. 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. Instruct MSBuild to write out the generated "metaproj" file to disk when building a solution file. Modifies Solution Generator to generate a metaproj that batches multiple Targets into one MSBuild task invoke. 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. Log statistics about property functions which require reflection Log all environment variables whether or not they are used in a build in the binary log. Log all environment variables whether or not they are used in a build in the binary log. Log property tracking information. When evaluating items, this is the minimum number of items on the running list to use a dictionary-based remove optimization. Name of environment variables used to enable MSBuild server. 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. 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. Force whether Project based evaluations should evaluate elements with false conditions. Always use the accurate-but-slow CreateFile approach to timestamp extraction. Truncate task inputs when logging them. This can reduce memory pressure at the expense of log usefulness. Disables truncation of Condition messages in Tasks/Targets via ExpanderOptions.Truncate. Disables skipping full drive/filesystem globs that are behind a false condition. Disables skipping full up to date check for immutable files. See FileClassifier class. When copying over an existing file, copy directly into the existing file rather than deleting and recreating. Emit events for project imports. Emit events for project imports. Read information only once per file per ResolveAssemblyReference invocation. Never use the slow (but more accurate) CreateFile approach to timestamp extraction. 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. Whether or not to ignore imports that are considered empty. See ProjectRootElement.IsEmptyXmlFile() for more info. Whether to respect the TreatAsLocalProperty parameter on the Project tag. Whether to write information about why we evaluate to debug output. Whether to warn when we set a property for the first time, after it was previously used. 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). Disable the use of paths longer than Windows MAX_PATH limits (260 characters) when running on a long path enabled OS. Disable the use of any caching when resolving SDKs. Don't delete TargetPath metadata from associated files found by RAR. Disable AssemblyLoadContext isolation for plugins. Enables the user of autorun functionality in CMD.exe on Windows which is disabled by default in MSBuild. Disables switching codepage to UTF-8 after detection of characters that can't be represented in the current codepage. Workaround for https://github.com/Microsoft/vstest/issues/1503. Use the original, string-only resx parsing in .NET Core scenarios. Escape hatch for problems arising from https://github.com/dotnet/msbuild/pull/4420. Overrides the default behavior of property expansion on evaluation of a . Escape hatch for problems arising from https://github.com/dotnet/msbuild/pull/5552. Allows displaying the deprecation warning for BinaryFormatter in your current environment. Throws InternalErrorException. Clone of ErrorUtilities.ThrowInternalError which isn't available in Framework. Throws InternalErrorException. This is only for situations that would mean that there is a bug in MSBuild itself. Clone from ErrorUtilities which isn't available in Framework. 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. The string to format. Optional arguments for formatting the given string. The formatted string. Clone from ResourceUtilities which isn't available in Framework. The arguments for an uninitialized property read event. UninitializedPropertyReadEventArgs Creates an instance of the UninitializedPropertyReadEventArgs class The name of the uninitialized property that was read. The message of the uninitialized property that was read. The helpKeyword of the uninitialized property that was read. The sender name of the event. The message importance of the event. The name of the uninitialized property that was read. Represents an argument to a . Functionally, it is simply a reference to another . Those who manually instantiate this class should remember to call before setting the first property and after setting the last property of the object. Default constructor needed for XAML deserialization. Name of the this argument refers to. Its value must point to a valid . This field is mandatory and culture invariant. Tells if the pointed to by must be defined for the definition of the owning this argument to make sense. This field is optional and is set to false by default. The string used to separate this argument value from the parent switch in the command line. This field is optional and culture invariant. See ISupportInitialize. See ISupportInitialize. Represents a property. This represents schema information (name, allowed values, etc) of a property. Since this is just schema information, there is no field like "Value" used to get/set the value of this property. Those who manually instantiate this class should remember to call before setting the first property and after setting the last property of the object. This partial class contains all properties which are public and hence settable in XAML. Those properties that are internal are defined in another partial class below. Represents a property. This represents schema information (name, allowed values, etc) of a property. Since this is just schema information, there is no field like "Value" used to get/set the value of this property. Those who manually instantiate this class should remember to call before setting the first property and after setting the last property of the object. This partial class contains members that are auto-generated, internal, etc. Whereas the other partial class contains public properties that can be set in XAML. See DisplayName property. Default constructor. Needed for deserializtion from a persisted format. The name of this . This field is mandatory and culture invariant. The value of this field cannot be set to the empty string. The name that could be used by a prospective UI client to display this . This field is optional and is culture sensitive. When this property is not set, it is assigned the same value as the property (and hence, would not be localized). Description of this for use by a prospective UI client. This field is optional and is culture sensitive. The keyword that is used to open the help page for this property. This form of specifying help takes precedence over and + . This field is optional and is culture insensitive. The URL of the help page for this property that will be opened when the user hits F1. This property is higher in priority that + (i.e., these two properties are ignored if is specified), but lower in priority than . This field is optional and is culture insensitive. ms-help://MS.VSCC.v80/MS.MSDN.v80/MS.VisualStudio.v80.en/dv_vstoc/html/06ddebea-2c83-4a45-bb48-6264c797ed93.htm The help file to use when the user hits F1. Must specify along with this. This property goes along with . . This form of specifying the help page for a property takes lower precedence than both and . This field is optional and is culture insensitive. The help context to use when the user hits F1. Must specify along with this. This property uses the property to display the help context of the specified help file. This field is optional. This form of specifying the help page for a property takes lower precedence than both and . The name of the category to which this property belongs to. If the value of this field does not correspond to the Name property of a element defined in the containing , a default with this name is auto-generated and added to the containing class. This field is optional and is culture invariant. When this field is not specified, this property is added to a auto-generated category called General (localized). This field cannot be set to the empty string. The sub category to which this property belongs to. Tells if this property is a read-only property. This field is optional and its default value is "false". A value indicating whether this property allows multiple values to be supplied/selected simultaneously. The switch representation of this property for the case when this property represents a tool parameter. This field is optional and culture invariant. For the VC++ CL task, WholeProgramOptimization is a boolean parameter. It's switch is GL. The prefix for the switch representation of this property for the case when this property represents a tool parameter. The value specified here overrides the value specified for the parent 's . This field is optional and culture invariant. For the VC++ CL task, WholeProgramOptimization is a boolean parameter. It's switch is GL and its switch prefix (inherited from the parent since it is not overridden by WholeProgramOptimization) is /. Thus the complete switch in the command line for this property would be /GL The token used to separate a switch from its value. The value specified here overrides the value specified for the parent 's . This field is optional and culture invariant. Example: Consider /D:WIN32. In this switch and value representation, ":" is the separator since its separates the switch D from its value WIN32. A hint to the UI client telling it whether to display this property or not. This field is optional and has the default value of "true". A hint to the command line constructor whether to include this property in the command line or not. Some properties are used only by the targets and don't want to be included in the command line. Others (like task parameters) are included in the command line in the form of the switch/value they emit. This field is optional and has the default value of true. Indicates whether this property is required to have a value set. Specifies the default value for this property. This field is optional and whether, for a , it is culture sensitive or not depends on the semantics of it. The data source where the current value of this property is stored. If defined, it overrides the property on the containing . This field is mandatory only if the parent does not have the data source initialized. The getter for this property returns only the set directly on this instance. Additional attributes of this . This can be used as a grab bag of additional metadata of this property that are not captured by the primary fields. You will need a custom UI to interpret the additional metadata since the shipped UI formats can't obviously know about it. This field is optional. List of arguments for this property. This field is optional. List of value editors for this property. This field is optional. The containing this . See ISupportInitialize. See ISupportInitialize. Represents the schame of a boolean property. Represents the logical negation of a boolean switch. For the VC++ CL task, WholeProgramOptimization is a boolean parameter. It's switch is GL. To disable whole program optimization, you need to pass the ReverseSwitch, which is GL-. This field is optional. Represents a category to which a can belong to. Those who manually instantiate this class should remember to call before setting the first property and after setting the last property of the object. This partial class contains all properties which are public and hence settable in XAML. Those properties that are internal are defined in another partial class below. Represents a category to which a can belong to. Those who manually instantiate this class should remember to call before setting the first property and after setting the last property of the object. This partial class contains members that are auto-generated, internal, etc. Whereas the other partial class contains public properties that can be set in XAML. See DisplayName property. The name of this . This field is mandatory and culture invariant. This field cannot be set to the empty string. The name that could be used by a prospective UI client to display this . This field is optional and is culture sensitive. When this property is not set, it is assigned the same value as the property (and hence, would not be localized). Description of this . This field is optional and is culture sensitive. Subtype of this . Is either Grid (default) or CommandLine. It helps the UI display this category in an appropriate form. E.g. non command line category properties are normally displayed in the form of a property grid. Help information for this . Maybe used to specify a help URL. This field is optional and is culture sensitive. Default constructor. Called during deserialization. See ISupportInitialize. See ISupportInitialize. The CategorySchema provides a strongly typed identity handle to the underlying schema data model. Used to deserialize the content type information metadata hash Constructor serializes IContentType.Name serializes IContentType.DisplayName serializes IContentType.ItemType serializes IContentType.DefaultContentTypeForItemType This property was never used for anything. It should have been removed before we shipped MSBuild 4.0. serializes content type's metadata. Accessible via IContentType.GetMetadata() Access metadata in convenient way See ISupportInitialize. See ISupportInitialize. see IProjectSchemaNode see IProjectSchemaNode Lazily initializes the metadata dictionary. The new dictionary. This is a destructive operation. It clears the NameValuePair list field. Indicates where the default value for some property may be found. The default value for a property is set at the top of the project file (usually via an import of a .props file). The default value for a property is set at the bottom of the project file (usually via an import of a .targets file, where the property definition is conditional on whether the property has not already been defined.) Represents the location and grouping for a . Those who manually instantiate this class should remember to call before setting the first property and after setting the last property of the object. Default constructor. Needed for proper XAML deserialization. The storage location for this data source. This field is mandatory unless is set. In that case, the parent will be used with the specified style. Example values are ProjectFile and UserFile. ProjectFile causes the property value to be written to and read from the project manifest file or the property sheet (depending on which node in the solution explorer/property manager window is used to spawn the property pages UI). UserFile causes the property value to be written to and read from the .user file. The storage style for this data source. For example, with of ProjectFile, this field can be Element (default) to save as a child XML Element, or Attribute to save properties as an XML attribute. Gets or sets the actual MSBuild property name used to read/write the value of this property. Applicable only to objects attached to properties. The MSBuild property name to use; or null to use the as the MSBuild property name. The persisted name will usually be the same as the property name as it appears in the and the value of this property can therefore be left at is default of null. Since property names must be unique but need not be unique in the persisted store (due to other differences in the data source such as item type) there may be times when Rule property names must be changed to be unique in the XAML file, but without changing how the property is persisted in the MSBuild file. It is in those cases where this property becomes useful. It may also be useful in specialized build environments where property names must differ from the normally used name in order to maintain compatibility with the project system. The label of the MSBuild property group/item definition group to which a property/item definition metadata belongs to. Default value is the empty string. A VC++ property that exists in the project manifest in the MSBuild property group with label Globals would have this same value for this field. If a is an item definition metadata or item metadata, this field specified the item type of the item definition or the item, respectively. For common properties this field must not be set. Indicates if a property is configuration-dependent as indicated by the presence of a configuration condition attached to the property definition at its persistence location. This field is optional and has the default value of true. The data type of the source. Generally one of Item, ItemDefinition, Property, or TargetResults (when is non-empty). Among other things this governs how the data is treated during build. A value of Item for this property indicates that this property is actually an item array - the list of all items with the item type specified by . Gets or sets the semicolon-delimited list of MSBuild targets that must be executed before reading the read-only properties or items described by this . Gets or sets a value indicating where the default value for this property can be found. See ISupportInitialize. See ISupportInitialize. Represents the schema of an enumeration property. This class inherits the property from the class. That property does not make sense for this property. Use the property on the instead to mark the default value for this property. constructor The provider that produces the list of possible values for this property. Must be set. A provider-specific set of options to pass to the provider. Represents the schema of an enumeration property. This class inherits the property from the class. That property does not make sense for this property. Use the property on the instead to mark the default value for this property. constructor The list of possible values for this property. Must have at least one value. See ISupportInitialize. Represents an admissible value of an . See DisplayName property. Default constructor needed for XAML deserialization. The name of this . This field is mandatory and culture invariant. The name that could be used by a prospective UI client to display this . This field is optional and is culture sensitive. When this property is not set, it is assigned the same value as the property (and hence, would not be localized). Description of this for use by a prospective UI client. This field is optional and is culture sensitive. Help information for this . Maybe used to specify a help URL. This field is optional and is culture sensitive. The switch representation of this property for the case when the parent represents a tool parameter. This field is optional and culture invariant. The VC compiler has an named Optimizationused to specify the desired optimization type. All the admissible values for this property have switches, e.g. Disabled (switch = Od), "MinimumSize" (switch = O1), etc. The prefix for the switch representation of this value for the case when the parent represents a tool parameter. This field is optional and culture invariant. Tells if this is the default value for the associated . This field is optional and the default value for this field is "false". Additional attributes of this . This can be used as a grab bag of additional metadata of this value that are not captured by the primary fields. You will need a custom UI to interpret the additional metadata since the shipped UI formats can't obviously know about it. This field is optional. List of arguments for this . This field is optional. simple class that deserialize extension to content type data Constructor file extension corresponding content type see IProjectSchemaNode see IProjectSchemaNode Represent the schema of an integer property. Minimum allowed value for this property. This field is optional. It returns null when this property is not set. The value of this property must be less than or equal to the property (assuming that the latter is defined). Maximum allowed value for this property. This field is optional. It returns null when this property is not set. The value of this property must be greater than or equal to the property (assuming that the latter is defined). See ISupportInitialize. Interface that we expect all root classes from project schema XAML files to implement Return all types of static data for data driven features this node contains Returns all instances of static data with Type "type". Null or Empty list if there is no objects from asked type provided by this node Used to deserialize the item type information Constructor serializes IItemType.Name serializes IItemType.DisplayName serializes IItemType.ItemType serializes IItemType.UpToDateCheckInput See ISupportInitialize. See ISupportInitialize. see IProjectSchemaNode see IProjectSchemaNode Represents a name-value pair. The name cannot be null or empty. Default constructor needed for The name. The value. Serialization class for node for the Data driven project schema XAML Constructor Collection of any schema node see IProjectSchemaNode see IProjectSchemaNode Methods for overriding one rule with another. A subsequent definition for a rule (with the same name) entirely overrides a previous definition. A subsequent definition for a rule (with the same name) adds properties to a previous definition. Used to represent the schema information for a Tool, a Custom Build Rule, a PropertyPage, etc. Normally represented on disk as XAML, only one instance of this class is maintained per XAML file per project engine (solution). Those who manually instantiate this class should remember to call before setting the first property and after setting the last property of the object. This partial class contains all properties which are public and hence settable in XAML. Those properties that are internal are defined in another partial class below. Used to represent the schema information for a Tool, a Custom Build Rule, a PropertyPage, etc. Normally represented on disk as XAML, only one instance of this class is maintained per XAML file per project engine (solution). Those who manually instantiate this class should remember to call before setting the first property and after setting the last property of the object. This partial class contains members that are auto-generated, internal, etc. Whereas the other partial class contains public properties that can be set in XAML. See DisplayName property. Default constructor. Needed for deserialization from a persisted format. The name of this . This field is mandatory and culture invariant. The value of this field cannot be set to the empty string. The name that could be used by a prospective UI client to display this . This field is optional and is culture sensitive. When this property is not set, it is assigned the same value as the property (and hence, would not be localized). The name of the tool executable when this rule represents a tool. Description of this for use by a prospective UI client. This field is optional and is culture sensitive. Help information for this . Maybe used to specify a help URL. This field is optional and is culture sensitive. The prefix to use for all property switches in this for the case when this property represent a tool. The value specified can be overridden by the value specified by a child 's . This field is optional and culture invariant. For the VC++ CL task, WholeProgramOptimization is a boolean parameter. It's switch is GL and its switch prefix (inherited from the parent since it is not overridden by WholeProgramOptimization) is /. Thus the complete switch in the command line for this property would be /GL The token used to separate a property switch from its value. The value specified here is overridden by the value specified by the child 's . This field is optional and culture invariant. Example: Consider /D:WIN32. In this switch and value representation, ":" is the separator since its separates the switch D from its value WIN32. The UI renderer template used to display this Rule. The value used to set this field can be anything as long as it is recognized by the intended renderer. This field is required only if this Rule is meant to be displayed as a property page. The for all the properties in this . This is overriden by any data source defined locally for a property. This field need not be specified only if all individual properties have data source defined locally. This is a suggestion to a prospective UI client on the relative location of this compared to all other Rules in the system. This is used to specify whether multiple files need to be batched on one command line invocation. This field is optional. Indicates whether to hide the command line category or not. Default value is true. This field is optional. When this represents a Build Customization, this field represents the file extension to associate. This field is optional. When this represents a Build Customization, this field represents the message to be displayed before executing a Build Customization during the build. This field is optional. When this represents a Build Customization, this field represents the command line template that is going to be used by a Build Customization task to invoke the tool. This field is optional. When this represents a Build Customization, this field defines the semicolon separated list of additional inputs that are going to be evaluated for the Build Customization target. This field is optional. When this represents a Build Customization, this field defines the semicolon separated list of outputs that are going to be evaluated for the Build Customization target. This field is optional. Gets or sets the method to use when multiple rules with the same name appear in the project to reconcile the rules into one instance. This list of properties in this . Atleast one property should be specified. The list returned by this property should not be modified. The list of s that properties in this belong to. This field is optional. Note that this field returns only the categories that were explicitly defined and do not contain any auto-generated categories. When a contained in this declares its category to be something that is not present in this list, then we auto-generate a with that name and add it to the internal list of categories. That auto-generated category will not be returned by this field. Gets or sets arbitrary metadata that may be set on a rule. Gets or sets a value indicating if property pages for this rule should be hidden or not. Thread synchronization. See the property. Ordered dictionary of category names and the properties contained in them. The order of the categories is exactly the same as that specified in the XAML file. A lookup cache of property names to properties. This property returns the union of XAML specified s and auto-generated s. The latter are created from the missing categories that are being referred to by the properties in this Rule. The auto-generated s only have their name set. Returns all properties partitioned into categories. The return value is never null. The returned list may contain auto-generated categories. Note that if a (or its derived classes) refer to a property that is not specified, then an new Category is generated for the same. If not category is specified for the property, then the property is placed in the "General" category. The list of categories is exactly as specified in the Xaml file. The auto-generated categories come (in no strict order) after the specified categories. A dictionary whose keys are the names and the value is the list of properties in that category. Returns the list of properties in a . Returns null if this doesn't contain this category. Returns a property with a given name. The property, or null if one with a matching name could not be found. See ISupportInitialize. See ISupportInitialize. see IProjectSchemaNode see IProjectSchemaNode Initializes this class after Xaml loading is done. Creates a map containing all the evaluated category names and the list of properties belonging to that category. This is a simple container for instances. Note that we only deal in terms of s as far as property pages are concerned. The is only used as a container for more than one . The containing s are immediately stripped off after loading of the xaml file. Default constructor needed for XAML deserialization. The collection of instances this instance contains. Must have at least one . See ISupportInitialize Members. See ISupportInitialize Members. see IProjectSchemaNode see IProjectSchemaNode The RuleSchema provides a strongly typed identity handle to the underlying schema data model. Represents the schema of a list-of-strings property. Note, this represents a list of strings, not a list of s. Default constructor. Needed for property XAML deserialization. The separator to use in delineating individual values of this string list property For Val1;Val2;Val3, if CommandLineValueSeparator is specified as, say ,, the command line looks like this: /p:val1,val2,val3 If not specified, the command line looks like this: /p:val1 /p:val2 /p:val3 This field is optional. Please don't use. This is planned to be deprecated. Qualifies this string property to give it a more specific classification. Similar to the property. Represents the schema of a string property. Qualifies this string property to give it a more specific classification. The value this field is set to, must be understood by the consumer of this field (normally a UI renderer). The value of this property can be set to, say, "File", "Folder", "CarModel" etc. to specify if this is a file path, folder path, car model name etc. Represents a value editor See DisplayName property. Default constructor needed for XAML deserialization. The name of this . This field is mandatory and culture invariant. The UI display name for the editor Additional attributes of the editor that are not generic enough to be made properties on this class. This field is optional. See ISupportInitialize. See ISupportInitialize. This class contains common reflection tasks This class contains utility methods for dealing with encoding. Get the current system locale code page, OEM version. OEM code pages are used for console-based input/output for historical reasons. Checks two encoding types to determine if they are similar to each other (equal or if the Encoding Name is the same). True if the two Encoding objects are equal or similar. Check if an encoding type is UTF8 (with or without BOM). True if the encoding is UTF8. Check the first 3 bytes of a stream to determine if it matches the UTF8 preamble. Steam to check. True when the first 3 bytes of the Stream are equal to the UTF8 preamble (BOM). Check the first 3 bytes of a stream to determine if it matches the given preamble. Steam to check. Preamble to look for. True when the first 3 bytes of the Stream are equal to the preamble. Check the first 3 bytes of a file to determine if it matches the 3-byte UTF8 preamble (BOM). Path to file to check. True when the first 3 bytes of the file are equal to the UTF8 BOM. Checks to see if a string can be encoded in a specified code page. Internal for testing purposes. Code page for encoding. String to encode. True if the string can be encoded in the specified code page. Find the encoding for the batch file. 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 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. The custom language that was set by the user for an 'external' tool besides MSBuild. Returns if none are set. 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 The custom language that was set by the user for an 'external' tool besides MSBuild. Returns null if none are set. 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 Query the Visual Studio setup API to get instances of Visual Studio installed on the machine. Will not include anything before Visual Studio "15". Enumerable list of Visual Studio instances Wrapper class to represent an installed instance of Visual Studio. Version of the Visual Studio Instance Path to the Visual Studio installation Full name of the Visual Studio instance with SKU name Constants that we want to be shareable across all our assemblies. The name of the property that indicates the tools path Name of the property that indicates the X64 tools path Name of the property that indicates the root of the SDKs folder Name of the property that indicates that all warnings should be treated as errors. Name of the property that indicates a list of warnings to treat as errors. Name of the property that indicates a list of warnings to not treat as errors. Name of the property that indicates the list of warnings to treat as messages. The name of the environment variable that users can specify to override where NuGet assemblies are loaded from in the NuGetSdkResolver. The name of the target to run when a user specifies the /restore command-line argument. The most current Visual Studio Version known to this version of MSBuild. The most current ToolsVersion known to this version of MSBuild. A property set during an implicit restore (/restore) or explicit restore (/t:restore) to ensure that the evaluations are not re-used during build A property set during an implicit restore (/restore) or explicit restore (/t:restore) to indicate that a restore is executing. The most current VSGeneralAssemblyVersion known to this version of MSBuild. Current version of this MSBuild Engine assembly in the form, e.g, "12.0" Symbol used in ProjectReferenceTarget items to represent default targets Framework version against which our test projects should be built. 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. 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. Specifies whether the current evaluation / build is happening during a graph build References to other msbuild projects Statically specifies what targets a project calls on its references Declares a project cache plugin and its configuration. Embed specified files in the binary log Constants naming well-known item metadata. The output path for a given item. Opaque holder of shared buffer. 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. Returns a read-only serializer. The serializer. Returns a write-only serializer. The stream containing data to serialize. The serializer. Implementation of ITranslator for reading from a stream. The stream used as a source or destination for data. The binary reader used in read mode. Constructs a serializer from the specified stream, operating in the designated mode. Delegates the Dispose call the to the underlying BinaryReader. Gets the reader, if any. Gets the writer, if any. Returns the current serialization mode. Translates a boolean. The value to be translated. Translates an array. The array to be translated. Translates a byte. The value to be translated. Translates a short. The value to be translated. Translates an unsigned short. The value to be translated. Translates an integer. The value to be translated. Translates an array. The array to be translated. Translates a long. The value to be translated. Translates a double. The value to be translated. Translates a string. The value to be translated. Translates a byte array The array to be translated Translates a byte array The array to be translated. The length of array which will be used in translation. This parameter is not used when reading Translates a string array. The array to be translated. Translates a list of strings The list to be translated. Translates a list of T using an The list to be translated. The translator to use for the items in the list TaskItem type Translates a collection of T into the specified type using an and The collection to be translated. The translator to use for the values in the collection. The factory to create the ICollection. The type contained in the collection. The type of collection to be created. Translates a DateTime. The value to be translated. Translates a TimeSpan. The value to be translated. Translates a BuildEventContext 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. The context to be translated. Translates a CultureInfo The CultureInfo to translate Translates an enumeration. The enumeration type. The enumeration instance to be translated. The enumeration value as an integer. 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. Translates a value using the .Net binary formatter. The reference type. The value to be translated. Translates an object implementing INodePacketTranslatable. The reference type. The value to be translated. Translates an array of objects implementing INodePacketTranslatable. The reference type. The array to be translated. Translates an array of objects using an The reference type. The array to be translated. The translator to use for the elements in the array Translates a dictionary of { string, string }. The dictionary to be translated. The comparer used to instantiate the dictionary. Translates a dictionary of { string, T }. The reference type for the values The dictionary to be translated. The comparer used to instantiate the dictionary. The translator to use for the values in the dictionary Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. The reference type for the dictionary. The reference type for values in the dictionary. The dictionary to be translated. The translator to use for the values in the dictionary Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. The reference type for the dictionary. The reference type for values in the dictionary. The dictionary to be translated. The translator to use for the values in the dictionary The delegate used to instantiate the dictionary. Reads in the boolean which says if this object is null or not. The type of object to test. True if the object should be read, false otherwise. Implementation of ITranslator for writing to a stream. The stream used as a source or destination for data. The binary writer used in write mode. Constructs a serializer from the specified stream, operating in the designated mode. The stream serving as the source or destination of data. Delegates the Dispose call the to the underlying BinaryWriter. Gets the reader, if any. Gets the writer, if any. Returns the current serialization mode. Translates a boolean. The value to be translated. Translates an array. The array to be translated. Translates a byte. The value to be translated. Translates a short. The value to be translated. Translates an unsigned short. The value to be translated. Translates an integer. The value to be translated. Translates an array. The array to be translated. Translates a long. The value to be translated. Translates a double. The value to be translated. Translates a string. The value to be translated. Translates a string array. The array to be translated. Translates a list of strings The list to be translated. Translates a list of T using an The list to be translated. The translator to use for the items in the list A TaskItemType Translates a list of T using an The list to be translated. The translator to use for the items in the list factory to create the IList A TaskItemType IList subtype Translates a collection of T into the specified type using an and The collection to be translated. The translator to use for the values in the collection. The factory to create the ICollection. The type contained in the collection. The type of collection to be created. Translates a DateTime. The value to be translated. Translates a TimeSpan. The value to be translated. Translates a BuildEventContext 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. The context to be translated. Translates a CultureInfo The CultureInfo Translates an enumeration. The enumeration type. The enumeration instance to be translated. The enumeration value as an integer. 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. Translates a value using the .Net binary formatter. The reference type. The value to be translated. Translates an object implementing INodePacketTranslatable. The reference type. The value to be translated. Translates a byte array The byte array to be translated Translates a byte array The array to be translated. The length of array which will be used in translation Translates an array of objects implementing INodePacketTranslatable. The reference type. The array to be translated. Translates an array of objects using an The reference type. The array to be translated. The translator to use for the elements in the array Translates a dictionary of { string, string }. The dictionary to be translated. The comparer used to instantiate the dictionary. Translates a dictionary of { string, T }. The reference type for the values, which implements INodePacketTranslatable. The dictionary to be translated. The comparer used to instantiate the dictionary. The translator to use for the values in the dictionary Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. The reference type for the dictionary. The reference type for values in the dictionary. The dictionary to be translated. The translator to use for the values in the dictionary Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. The reference type for the dictionary. The reference type for values in the dictionary. The dictionary to be translated. The translator to use for the values in the dictionary The delegate used to instantiate the dictionary. Translates a dictionary of { string, DateTime }. The dictionary to be translated. Key comparer Writes out the boolean which says if this object is null or not. The object to test. The type of object to test. True if the object should be written, false otherwise. An interface representing an object which may be serialized by the node packet serializer. Reads or writes the packet to the serializer. 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. The type to be translated. Delegate for users that want to translate an arbitrary structure that doesn't implement (e.g. translating a complex collection) the translator the object to translate This delegate is used to create arbitrary collection types for serialization. The type of dictionary to be created. The serialization mode. Indicates the serializer is operating in write mode. Indicates the serializer is operating in read mode. This interface represents an object which aids objects in serializing and deserializing INodePackets. 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. Returns the current serialization mode. Returns the binary reader. 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. Returns the binary writer. 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. Translates a boolean. The value to be translated. Translates an array. The array to be translated. Translates a byte. The value to be translated. Translates a short. The value to be translated. Translates a unsigned short. The value to be translated. Translates an integer. The value to be translated. Translates an unsigned integer. The unsigned integer to translate. Translates an array. The array to be translated. Translates a long. The value to be translated. Translates a string. The value to be translated. Translates a double. The value to be translated. Translates a string array. The array to be translated. Translates a list of strings The list to be translated. Translates a set of strings The set to be translated. Translates a list of T using an The list to be translated. The translator to use for the items in the list A TaskItemType Translates a list of T using an anda collection factory The list to be translated. The translator to use for the items in the list An ITranslatable subtype An IList subtype factory to create a collection Translates a collection of T into the specified type using an and The collection to be translated. The translator to use for the values in the collection. The factory to create the ICollection. The type contained in the collection. The type of collection to be created. Translates a DateTime. The value to be translated. Translates a TimeSpan. The value to be translated. Translates a BuildEventContext 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. The context to be translated. Translates an enumeration. The enumeration type. The enumeration instance to be translated. The enumeration value as an integer. 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. Translates a value using the .Net binary formatter. The reference type. The value to be translated. 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. Translates an object implementing INodePacketTranslatable. The reference type. The value to be translated. Translates a culture The culture Translates a byte array The array to be translated. Translates a byte array The array to be translated. The length of array which will be used in translation Translates an array of objects implementing INodePacketTranslatable. The reference type. The array to be translated. Translates an array of objects using an . The reference type. The array to be translated. The translator to use for the elements in the array. Translates a dictionary of { string, string }. The dictionary to be translated. The comparer used to instantiate the dictionary. Translates a dictionary of { string, T }. The reference type for the values, which implements INodePacketTranslatable. The dictionary to be translated. The comparer used to instantiate the dictionary. The translator to use for the values in the dictionary Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. The reference type for the dictionary. The reference type for values in the dictionary. The dictionary to be translated. The translator to use for the values in the dictionary. Translates a dictionary of { string, T } for dictionaries with public parameterless constructors. The reference type for the dictionary. The reference type for values in the dictionary. The dictionary to be translated. The translator to use for the values in the dictionary A factory used to create the dictionary. Translates the boolean that says whether this value is null or not The object to test. The type of object to test. True if the object should be written, false otherwise. A collection of standard ANSI/VT100 control codes. The control sequence introducer. Select graphic rendition. Print color-code to change text color. Select graphic rendition - set bold mode. Print to change text to bold. A shortcut to reset color back to normal. Non-xterm extension to render a hyperlink. Print urltext to render a hyperlink. Moves up the specified number of lines and puts cursor at the beginning of the line. Print N to move N lines up. Moves forward (to the right) the specified number of characters. Print N to move N characters forward. Moves backward (to the left) the specified number of characters. Print N to move N characters backward. Clears everything from cursor to end of screen. Print to clear. Clears everything from cursor to the end of the current line. Print to clear. Hides the cursor. Shows/restores the cursor. Set progress state to a busy spinner.
Note: this code works only on ConEmu terminals, and conflicts with push a notification code on iTerm2. ConEmu specific OSC codes.
iTerm2 proprietary escape codes. Remove progress state, restoring taskbar status to normal.
Note: this code works only on ConEmu terminals, and conflicts with push a notification code on iTerm2. ConEmu specific OSC codes.
iTerm2 proprietary escape codes. Moves cursor to the specified column, or the rightmost column if is greater than the width of the terminal. Column index. Control codes to set the desired position. Enumerates the text colors supported by VT100 terminal. This captures information of how various key methods of building with MSBuild ran. Changes to existing event method signatures will not be reflected unless you update the property or assign a new event ID. Keyword applied to all MSBuild events. Literally every event should define this. Keyword for events that should go in the text performance log when turned on. This keyword should be applied only to events that are low-volume and likely to be useful to diagnose perf issues using the text perf log. define the singleton instance of the event source 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. The type of the item being mutated. The type of the item being mutated. Call this method to notify listeners of information relevant to the setup for a BuildManager to receive build requests. Call this method to notify listeners of information of how a project file built. Filename of the project being built. Filename of the project being built. Names of the targets that built. The condition being evaluated. The condition being evaluated. The result of evaluating the condition. Call this method to notify listeners of how the project data was evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Filename of the project being evaluated. Call this method to notify listeners of information relevant to identifying a list of files that correspond to an item with a wildcard. Source of files to glob. Pattern, possibly with wildcard(s) to be expanded. Patterns not to expand. Source of files to glob. Pattern, possibly with wildcard(s) to be expanded. Patterns not to expand. Call this method to notify listeners of timing related to loading an XmlDocumentWithLocation from a path. Path to the document to load. Path to the document to load. Call this method to notify listeners of profiling for the function that parses an XML document into a ProjectRootElement. Filename of the project being evaluated. Filename of the project being evaluated. 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. Project file's location. Project file's location. The name of the target being executed. The name of the target being executed. Call this method to notify listeners of the start of a build as called from the command line. The command line used to run MSBuild. The command line used to run MSBuild. This events are quite frequent so they are collected by Debug binaries only. This events are quite frequent so they are collected by Debug binaries only. 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. SupportedOSPlatform is a net5.0+ Attribute. Create the same type only in full-framework and netstandard2.0 builds to prevent many #if RUNTIME_TYPE_NETCORE checks. Specifies that null is allowed as an input even if the corresponding type disallows it. Specifies that null is disallowed as an input even if the corresponding type allows it. Specifies that an output may be null even if the corresponding type disallows it. Specifies that an output will not be null even if the corresponding type allows it. Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it. Initializes the attribute with the specified return value condition. The return value condition. If the method returns this value, the associated parameter may be null. Gets the return value condition. Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. Initializes the attribute with the specified return value condition. The return value condition. If the method returns this value, the associated parameter will not be null. Gets the return value condition. Specifies that the output will be non-null if the named parameter is non-null. Initializes the attribute with the associated parameter name. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null. Gets the associated parameter name. Applied to a method that will never return under any circumstance. Specifies that the method will not return if the associated Boolean parameter is passed the specified value. Initializes the attribute with the specified parameter value. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to the associated parameter matches this value. Gets the condition parameter value. Specifies that the method or property will ensure that the listed field and property members have not-null values. Initializes the attribute with a field or property member. The field or property member that is promised to be not-null. Initializes the attribute with the list of field and property members. The list of field and property members that are promised to be not-null. Gets field or property member names. Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition. Initializes the attribute with the specified return value condition and a field or property member. The return value condition. If the method returns this value, the associated parameter will not be null. The field or property member that is promised to be not-null. Initializes the attribute with the specified return value condition and list of field and property members. The return value condition. If the method returns this value, the associated parameter will not be null. The list of field and property members that are promised to be not-null. Gets the return value condition. Gets field or property member names.