Microsoft.Build.Framework Пространство имен

Содержит типы, определяющие, каким образом задачи и средства ведения журнала взаимодействуют с обработчиком MSBuild. Contains the types that define how tasks and loggers interact with the MSBuild engine. Дополнительные сведения см. в разделе MSBuild. For information, see MSBuild.

Классы

BuildErrorEventArgs

Аргументы для событий ошибокArguments for error events

BuildEventArgs

Этот класс инкапсулирует данные по умолчанию, связанные с событиями сборки.This class encapsulates the default data associated with build events. Он должен быть расширенным классом или подклассом.It is intended to be extended/sub-classed.

BuildEventContext

Предоставляет сведения о расположении для события, что особенно полезно в средах с несколькими процессорами.Will provide location information for an event, this is especially needed in a multi processor environment

BuildFinishedEventArgs

Этот класс представляет аргументы события для завершенных событий сборки.This class represents the event arguments for build finished events.

BuildMessageEventArgs

Аргументы для событий сообщений.Arguments for message events

BuildStartedEventArgs

Аргументы для событий запуска сборки.Arguments for build started events.

BuildStatusEventArgs

Базовый класс для событий состояния сборки.Base class for build status events. Этот класс предназначен для расширения.This class is meant to be extended.

BuildWarningEventArgs

Аргументы для событий предупрежденияArguments for warning events

CriticalBuildMessageEventArgs

Аргументы для критических событий сообщений.Arguments for critical message events. Они всегда имеют высокую важность.These always have High importance.

CustomBuildEventArgs

Аргументы для пользовательских событий сборки.Arguments for custom build events.

EnvironmentVariableReadEventArgs

Аргументы для события считывания переменной среды.Arguments for the environment variable read event.

ExternalProjectFinishedEventArgs

Аргументы для завершенных событий внешнего проекта.Arguments for external project finished events

ExternalProjectStartedEventArgs

Аргументы для событий запуска внешнего проекта.Arguments for external project started events

LazyFormattedBuildEventArgs

Сохраняет строки для частей сообщения, задерживая форматирование до момента, когда оно должно быть показано.Stores strings for parts of a message delaying the formatting until it needs to be shown

LoadInSeparateAppDomainAttribute

Этот атрибут используется для пометки задач, которые должны выполняться в собственных доменах приложений.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.

LoggerException

Исключение, которое должно вызываться средством ведения журнала, когда оно не может продолжать работу.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.

MetaprojectGeneratedEventArgs

Аргументы для события, созданного метапроектом.Arguments for the metaproject generated event.

OutputAttribute

Этот атрибут используется авторами задач для обозначения определенных параметров задачи в виде выходных данных.This attribute is used by task writers to designate certain task parameters as "outputs". Обработчик сборки будет разрешать только параметры задач (т. е. свойства .NET класса Task), которые помечены этим атрибутом для вывода данных из задачи.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.

ProjectEvaluationFinishedEventArgs

Аргументы для события завершения оценки проекта.Arguments for the project evaluation finished event.

ProjectEvaluationStartedEventArgs

Аргументы для события начала оценки проекта.Arguments for the project evaluation started event.

ProjectFinishedEventArgs

Аргументы для событий завершения проектаArguments for project finished events

ProjectImportedEventArgs

Аргументы для события импорта проекта.Arguments for the project imported event.

ProjectStartedEventArgs

Аргументы для событий запуска проектаArguments for project started events

PropertyInitialValueSetEventArgs

Аргумент для события установки начального значения свойства.The argument for a property initial value set event.

PropertyReassignmentEventArgs

Аргумент для события переназначения свойства.The argument for a property reassignment event.

RequiredAttribute

Этот класс определяет атрибут, который модуль записи задач может применить к свойству задачи, чтобы объявить свойство как обязательное свойство.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.

RequiredRuntimeAttribute

При пометке с помощью Рекуиредрунтимеаттрибуте задача указывает, что она имеет более подробные требования к среде выполнения, чем обычная задача. это указывает MSBuild, что ему потребуется запустить отдельный процесс для этой задачи, если текущая среда выполнения не соответствует требованию к версии.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. Этот атрибут в настоящее время нефункциональный, поскольку существует только одна версия среды CLR, способная работать с MSBuild версии 2.0 или v 3.5 — среда выполнения версии 2.0This 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

RunInMTAAttribute

Атрибут используется, чтобы пометить класс задачи, как не требующий выполнения в STA для модели COM.This attribute is used to mark a task class as explicitly not being required to run in the STA for COM.

RunInSTAAttribute

Атрибут используется, чтобы пометить класс задачи, как не требующий выполнения в режиме однопотокового подразделения для модели COM.This attribute is used to mark a task class as being required to run in a Single Threaded Apartment for COM.

SdkLogger

Абстрактный класс интерфейса, который обеспечивает ведение журнала в режиме реального времени и сведения о состоянии при разрешении пакета SDK.An abstract interface class to providing real-time logging and status while resolving an SDK.

SdkReference

Представляет комплект SDK для разработки ПО, на который указывает ссылка в элементе <Project /> или <Import />.Represents a software development kit (SDK) that is referenced in a <Project /> or <Import /> element.

SdkResolver

Абстрактный интерфейс для классов, которые могут разрешать пакет средств разработки программного обеспечения (SDK).An abstract interface for classes that can resolve a Software Development Kit (SDK).

SdkResolverContext

Контекст, используемый SdkResolver для разрешения пакета SDK.Context used by an SdkResolver to resolve an SDK.

SdkResult

Абстрактный класс интерфейса, указывающий на успех или сбой сопоставителя пакетов SDK.An abstract interface class to indicate SDK resolver success or failure. Примечание. Используйте SdkResultFactory для создания экземпляров этого класса.Note: Use SdkResultFactory to create instances of this class. Не используйте наследование от этого класса.Do not inherit from this class.

SdkResultFactory

Абстрактный класс интерфейса, предоставляемый для SdkResolver с целью создания объекта SdkResult, который указывает на успешное выполнение или сбой.An abstract interface class provided to SdkResolver to create an SdkResult object indicating success / failure.

SdkResultItem

Значение элемента и все связанные с ним метаданные, добавляемые сопоставителем пакета SDK.The value of an item and any associated metadata to be added by an SDK resolver. См. также ItemsToAdd.Also see ItemsToAdd.

TargetFinishedEventArgs

Аргументы для событий завершения целевого объектаArguments for target finished events

TargetSkippedEventArgs

Аргументы для события пропуска целевого объекта.Arguments for the target skipped event.

TargetStartedEventArgs

Аргументы для событий запуска целевого объектаArguments for target started events

TaskCommandLineEventArgs

Этот класс используется задачами для регистрации командных строк.This class is used by tasks to log their command lines. Этот класс расширяет BuildMessageEventArgs, чтобы командные строки можно было записывать в журнал как сообщения.This class extends BuildMessageEventArgs so that command lines can be logged as messages. Командную строку следует заносить в журнал только для задач, служащих оболочкой для базового исполняемого файла или инструмента или эмулирующих команду оболочки.Logging a command line is only relevant for tasks that wrap an underlying executable/tool, or emulate a shell command. Задачи, не имеющие эквивалента командной строки, не должны вызывать это событие расширенного сообщения.Tasks that have no command line equivalent should not raise this extended message event.

TaskFinishedEventArgs

Аргументы для событий завершения задачиArguments for task finished events

TaskPropertyInfo

Класс, представляющий сведения о параметрах из задачи using как строго типизированный класс.Class which represents the parameter information from the using task as a strongly typed class.

TaskStartedEventArgs

Аргументы для событий запуска задачиArguments for task started events

TelemetryEventArgs

Аргументы для событий телеметрии.Arguments for telemetry events.

UninitializedPropertyReadEventArgs

Аргументы для события считывания неинициализированного свойства.The arguments for an uninitialized property read event.

Структуры

BuildEngineResult

Эта структура используется для возврата результатов сборки и целевых выходных данных.This structure is used to return the result of the build and the target outputs.

Интерфейсы

IBuildEngine

Этот интерфейс предоставляет функциональные возможности обработчика сборок, необходимого для создания задач.This interface exposes functionality on the build engine that is required for task authoring.

IBuildEngine2

Этот интерфейс расширяет IBuildEngine для предоставления метода, позволяющего выполнять построение файлов проекта параллельно.This interface extends IBuildEngine to provide a method allowing building project files in parallel.

IBuildEngine3

Этот интерфейс расширяет IBuildEngine для предоставления метода, позволяющего выполнять построение файлов проекта параллельно.This interface extends IBuildEngine to provide a method allowing building project files in parallel.

IBuildEngine4

Этот интерфейс расширяет IBuildEngine для обеспечения механизма, позволяющего задачам совместное использование данных между вызовами задачи.This interface extends IBuildEngine to provide a mechanism allowing tasks to share data between task invocations.

IBuildEngine5

Этот интерфейс расширяет IBuildEngine для записи данных телеметрии в журнал.This interface extends IBuildEngine to log telemetry.

IBuildEngine6

Этот интерфейс расширяет IBuildEngine5, позволяя задачам получать глобальные свойства текущего проекта.This interface extends IBuildEngine5 to allow tasks to get the current project's global properties.

IBuildEngine7

Этот интерфейс расширяет IBuildEngine6, позволяя задачам указывать, нужно ли регистрировать ошибку при возврате задачи без регистрации ошибки.This interface extends IBuildEngine6 to allow tasks to set whether they want to log an error when a task returns without logging an error.

ICancelableTask

Интерфейс для задач, которые можно отменить.Interface for tasks which can be cancelled.

IEventRedirector

Этот интерфейс используется для перенаправления событий в другие средства ведения журнала.This interface is used to forward events to another loggers

IEventSource

Этот интерфейс определяет события, создаваемые обработчиком сборки.This interface defines the events raised by the build engine. Средства ведения журнала используют этот интерфейс для подписки на события, которые им нужно получать.Loggers use this interface to subscribe to the events they are interested in receiving.

IEventSource2

Этот интерфейс определяет события, создаваемые обработчиком сборки.This interface defines the events raised by the build engine. Средства ведения журнала используют этот интерфейс для подписки на события, которые им нужно получать.Loggers use this interface to subscribe to the events they are interested in receiving.

IEventSource3

Этот интерфейс определяет события, создаваемые обработчиком сборки.This interface defines the events raised by the build engine. Средства ведения журнала используют этот интерфейс для подписки на события, которые им нужно получать.Loggers use this interface to subscribe to the events they are interested in receiving.

IForwardingLogger

Этот интерфейс расширяет интерфейс ILogger, чтобы предоставить свойство, которое можно использовать для перенаправления событий в средство ведения журнала, выполняющееся в другом процессе.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 create filtering loggers.

IGeneratedTask

Интерфейс, реализуемый задачами, созданными экземплярами Итаскфактори.An interface implemented by tasks that are generated by ITaskFactory instances.

ILogger

Этот интерфейс определяет средство ведения журнала в системе сборки.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.

INodeLogger

Этот интерфейс определяет средство ведения журнала с поддержкой параллельной обработки в системе сборки.This interface defines a "parallel aware logger" in the build system. Средство ведения журнала с поддержкой параллельной обработки будет принимать значение счетчика ЦП, учитывая, что значение больше 1 означает, что события будут получены из средства ведения журнала от каждого ЦП по мере регистрации событий.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.

IProjectElement

Интерфейс для предоставления ProjectElement соответствующим средствам ведения журнала.Interface for exposing a ProjectElement to the appropriate loggers

ITask

Этот интерфейс определяет задачу в системе сборки.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.

ITaskFactory

Интерфейс, который должен быть реализован экземпляром фабрики задачInterface that a task factory Instance should implement

ITaskFactory2

Интерфейс, который должен быть реализован экземпляром фабрики задач, если он хочет иметь возможность использовать новые параметры UsingTask, такие как среда выполнения и архитектура.Interface that a task factory Instance should implement if it wants to be able to use new UsingTask parameters such as Runtime and Architecture.

ITaskHost

Этот пустой интерфейс используется для передачи объектов узла из интегрированной среды разработки в отдельные задачи.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.

ITaskItem

Этот интерфейс определяет элемент проекта, который можно использовать и создавать с помощью задач.This interface defines a project item that can be consumed and emitted by tasks.

ITaskItem2

Интерфейс добавляет поддержку преобразования в escape-символы в интерфейс ITaskItem.This interface adds escaping support to the ITaskItem interface.

Перечисления

LoggerVerbosity

Перечисление уровней детализации для журнала событий.Enumeration of the levels of detail of an event log.

MessageImportance

Это перечисление предоставляет три уровня важности для сообщений.This enumeration provides three levels of importance for messages.

RegisteredTaskObjectLifetime

Определяет время существования зарегистрированного объекта задачи.Defines the lifetime of a registered task object.

TargetBuiltReason

Причина, по которой построение целевого объекта было выполнено родительским целевым объектом.The reason that a target was built by its parent target.

Делегаты

AnyEventHandler

Тип обработчика для событий АневентраиседType of handler for AnyEventRaised events

BuildErrorEventHandler

Тип обработчика для событий ЕррорраиседType of handler for ErrorRaised events

BuildFinishedEventHandler

Тип обработчика для событий БуилдфинишедевентType of handler for BuildFinishedEvent events

BuildMessageEventHandler

Тип обработчика для событий МессажераиседType of handler for MessageRaised events

BuildStartedEventHandler

Тип обработчика для событий БуилдстартедевентType of handler for BuildStartedEvent events

BuildStatusEventHandler

Тип обработчика для событий БуилдстатусType of handler for BuildStatus events

BuildWarningEventHandler

Тип обработчика для событий ВарнинграиседType of handler for WarningRaised events

CustomBuildEventHandler

Тип обработчика для событий КустомевентраиседType of handler for CustomEventRaised events

ProjectFinishedEventHandler

Тип обработчика для событий ProjectFinishedType of handler for ProjectFinished events

ProjectStartedEventHandler

Тип обработчика для событий ProjectStartedType of handler for ProjectStarted events

TargetFinishedEventHandler

Тип обработчика для событий ТаржетфинишедType of handler for TargetFinished events

TargetStartedEventHandler

Тип обработчика для событий TargetStartedType of handler for TargetStarted events

TaskFinishedEventHandler

Тип обработчика для событий ТаскфинишедType of handler for TaskFinished events

TaskStartedEventHandler

Тип обработчика для событий ТаскстартедType of handler for TaskStarted events

TelemetryEventHandler

Тип обработчика для событий TelemetryLogged.Type of handler for TelemetryLogged events