mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
linux-packaging-mono/mcs/class/Microsoft.Build.Engine/Documentation/en/Microsoft.Build.BuildEngine/Engine.xml
Jo Shields a575963da9 Imported Upstream version 3.6.0 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

694 lines
34 KiB
XML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<Type Name="Engine" FullName="Microsoft.Build.BuildEngine.Engine">
<TypeSignature Language="C#" Value="public class Engine" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>In a system of project-to-project dependencies, the <see cref="T:Microsoft.Build.BuildEngine.Engine" /> maintains the building projects, making it possible to avoid building the same target in the same project more than once in a given build.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the vstecmsbuild engine.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Engine ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:Microsoft.Build.BuildEngine.Engine" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Engine (string binPath);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="binPath" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:Microsoft.Build.BuildEngine.Engine" /> class that has the specified <see cref="P:Microsoft.Build.BuildEngine.Engine.BinPath" />.</para>
</summary>
<param name="binPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to MSBuild.exe.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BinPath">
<MemberSignature Language="C#" Value="public string BinPath { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>In vstecmsbuild 3.5, the "BinPath" is superseded by the "ToolsPath." Therefore, in the .Targets file, use MSBuildToolsPath rather than MBBuildBinPath. In the vstecmsbuild object model, "BinPath" relates to the Toolset you are running. The steps to get the path from the build engine are as follows:</para>
<list type="ordered">
<item>
<para>Get the default tools version.</para>
</item>
<item>
<para>Get the Toolset map.</para>
</item>
<item>
<para>Find the Toolset, based on the string in the map.</para>
</item>
<item>
<para>Get the Toolset.</para>
</item>
<item>
<para>Get the path from the Toolset.</para>
</item>
</list>
<para>This procedure is not required if you are creating the engine. In that case, you already know the Toolset path.</para>
<para>Because projects in a solution can use different Toolsets, you can also obtain the MSBuild.exe path from the project, as follows.</para>
<code>project.EvaluatedProperties[ReservedPropertyNames.toolsPath].FinalValue </code>
<para>For more information about Toolsets, see MSBuild Tool Set (ToolsVersion).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the path to MSBuild.exe.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildEnabled">
<MemberSignature Language="C#" Value="public bool BuildEnabled { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that indicates whether the building of targets in the project is enabled.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProject">
<MemberSignature Language="C#" Value="public bool BuildProject (Microsoft.Build.BuildEngine.Project project);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="project" Type="Microsoft.Build.BuildEngine.Project" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Builds the specified <see cref="T:Microsoft.Build.BuildEngine.Project" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="project">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.Project" /> to build.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProject">
<MemberSignature Language="C#" Value="public bool BuildProject (Microsoft.Build.BuildEngine.Project project, string targetName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="project" Type="Microsoft.Build.BuildEngine.Project" />
<Parameter Name="targetName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Builds the specified target of the specified <see cref="T:Microsoft.Build.BuildEngine.Project" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="project">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.Project" /> to build.</param>
<param name="targetName">
<attribution license="cc4" from="Microsoft" modified="false" />The Name attribute of the Target element to build.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProject">
<MemberSignature Language="C#" Value="public bool BuildProject (Microsoft.Build.BuildEngine.Project project, string[] targetNames);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="project" Type="Microsoft.Build.BuildEngine.Project" />
<Parameter Name="targetNames" Type="System.String[]" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Builds the specified targets of the specified <see cref="T:Microsoft.Build.BuildEngine.Project" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="project">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.Project" /> to build.</param>
<param name="targetNames">
<attribution license="cc4" from="Microsoft" modified="false" />An array that contains the Name attributes of the Target elements to build.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProject">
<MemberSignature Language="C#" Value="public bool BuildProject (Microsoft.Build.BuildEngine.Project project, string[] targetNames, System.Collections.IDictionary targetOutputs);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="project" Type="Microsoft.Build.BuildEngine.Project" />
<Parameter Name="targetNames" Type="System.String[]" />
<Parameter Name="targetOutputs" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Builds the specified targets of the specified <see cref="T:Microsoft.Build.BuildEngine.Project" />, and returns the outputs of the targets.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="project">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.Project" /> to build.</param>
<param name="targetNames">
<attribution license="cc4" from="Microsoft" modified="false" />An array that contains the Name attributes of the Target elements to build.</param>
<param name="targetOutputs">
<attribution license="cc4" from="Microsoft" modified="false" />The outputs of the built targets. This parameter can be a null reference (Nothing in vbprvb) if outputs are not required.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProject">
<MemberSignature Language="C#" Value="public bool BuildProject (Microsoft.Build.BuildEngine.Project project, string[] targetNames, System.Collections.IDictionary targetOutputs, Microsoft.Build.BuildEngine.BuildSettings buildFlags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="project" Type="Microsoft.Build.BuildEngine.Project" />
<Parameter Name="targetNames" Type="System.String[]" />
<Parameter Name="targetOutputs" Type="System.Collections.IDictionary" />
<Parameter Name="buildFlags" Type="Microsoft.Build.BuildEngine.BuildSettings" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Builds the specified targets of the specified <see cref="T:Microsoft.Build.BuildEngine.Project" /> with the specified <see cref="T:Microsoft.Build.BuildEngine.BuildSettings" />, and returns the outputs of the targets.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="project">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.Project" /> to build.</param>
<param name="targetNames">
<attribution license="cc4" from="Microsoft" modified="false" />An array that contains the Name attributes of the Target elements to build.</param>
<param name="targetOutputs">
<attribution license="cc4" from="Microsoft" modified="false" />The outputs of the built targets. This parameter can be a null reference (Nothing in vbprvb) if outputs are not required.</param>
<param name="buildFlags">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.BuildSettings" /> to apply to the build.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProjectFile">
<MemberSignature Language="C#" Value="public bool BuildProjectFile (string projectFile);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Loads the specified project file and builds the project.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="projectFile">
<attribution license="cc4" from="Microsoft" modified="false" />The project file to load and build.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProjectFile">
<MemberSignature Language="C#" Value="public bool BuildProjectFile (string projectFile, string targetName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
<Parameter Name="targetName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Loads the specified project file and builds the specified target of the project.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="projectFile">
<attribution license="cc4" from="Microsoft" modified="false" />The project file to load and build.</param>
<param name="targetName">
<attribution license="cc4" from="Microsoft" modified="false" />The Name attribute of the Target element to build.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProjectFile">
<MemberSignature Language="C#" Value="public bool BuildProjectFile (string projectFile, string[] targetNames);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
<Parameter Name="targetNames" Type="System.String[]" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Loads the specified project file and builds the specified targets of the project.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="projectFile">
<attribution license="cc4" from="Microsoft" modified="false" />The project file to load and build.</param>
<param name="targetNames">
<attribution license="cc4" from="Microsoft" modified="false" />An array that contains the Name attributes of the Target elements to build.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProjectFile">
<MemberSignature Language="C#" Value="public bool BuildProjectFile (string projectFile, string[] targetNames, Microsoft.Build.BuildEngine.BuildPropertyGroup globalProperties);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
<Parameter Name="targetNames" Type="System.String[]" />
<Parameter Name="globalProperties" Type="Microsoft.Build.BuildEngine.BuildPropertyGroup" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Loads the specified project file and builds the specified targets of the project with the specified <see cref="P:Microsoft.Build.BuildEngine.Engine.GlobalProperties" />, and returns the outputs of the targets.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="projectFile">
<attribution license="cc4" from="Microsoft" modified="false" />The project file to load and build.</param>
<param name="targetNames">
<attribution license="cc4" from="Microsoft" modified="false" />An array that contains the Name attributes of the Target elements to build.</param>
<param name="globalProperties">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:Microsoft.Build.BuildEngine.Engine.GlobalProperties" /> to apply to the build.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProjectFile">
<MemberSignature Language="C#" Value="public bool BuildProjectFile (string projectFile, string[] targetNames, Microsoft.Build.BuildEngine.BuildPropertyGroup globalProperties, System.Collections.IDictionary targetOutputs);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
<Parameter Name="targetNames" Type="System.String[]" />
<Parameter Name="globalProperties" Type="Microsoft.Build.BuildEngine.BuildPropertyGroup" />
<Parameter Name="targetOutputs" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Loads the specified project file and builds the specified targets of the project with the specified <see cref="P:Microsoft.Build.BuildEngine.Engine.GlobalProperties" />, and returns the outputs of the targets.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="projectFile">
<attribution license="cc4" from="Microsoft" modified="false" />The project file to load and build.</param>
<param name="targetNames">
<attribution license="cc4" from="Microsoft" modified="false" />An array that contains the Name attributes of the Target elements to build.</param>
<param name="globalProperties">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:Microsoft.Build.BuildEngine.Engine.GlobalProperties" /> to apply to the build.</param>
<param name="targetOutputs">
<attribution license="cc4" from="Microsoft" modified="false" />The outputs of the built targets. This parameter can be a null reference (Nothing in vbprvb) if outputs are not required.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildProjectFile">
<MemberSignature Language="C#" Value="public bool BuildProjectFile (string projectFile, string[] targetNames, Microsoft.Build.BuildEngine.BuildPropertyGroup globalProperties, System.Collections.IDictionary targetOutputs, Microsoft.Build.BuildEngine.BuildSettings buildFlags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
<Parameter Name="targetNames" Type="System.String[]" />
<Parameter Name="globalProperties" Type="Microsoft.Build.BuildEngine.BuildPropertyGroup" />
<Parameter Name="targetOutputs" Type="System.Collections.IDictionary" />
<Parameter Name="buildFlags" Type="Microsoft.Build.BuildEngine.BuildSettings" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Loads the specified project file and builds the specified targets of the project with the specified <see cref="T:Microsoft.Build.BuildEngine.BuildSettings" /> and <see cref="P:Microsoft.Build.BuildEngine.Engine.GlobalProperties" />, and returns the outputs of the targets.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the build was successful; otherwise, false.</para>
</returns>
<param name="projectFile">
<attribution license="cc4" from="Microsoft" modified="false" />The project file to load and build.</param>
<param name="targetNames">
<attribution license="cc4" from="Microsoft" modified="false" />An array that contains the Name attributes of the Target elements to build.</param>
<param name="globalProperties">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:Microsoft.Build.BuildEngine.Engine.GlobalProperties" /> to apply to the build.</param>
<param name="targetOutputs">
<attribution license="cc4" from="Microsoft" modified="false" />The outputs of the built targets. This parameter can be a null reference (Nothing in vbprvb) if outputs are not required.</param>
<param name="buildFlags">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.BuildSettings" /> to apply to the build.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateNewProject">
<MemberSignature Language="C#" Value="public Microsoft.Build.BuildEngine.Project CreateNewProject ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.BuildEngine.Project</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates an empty <see cref="T:Microsoft.Build.BuildEngine.Project" /> object that is associated with this <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The created <see cref="T:Microsoft.Build.BuildEngine.Project" /> object.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetLoadedProject">
<MemberSignature Language="C#" Value="public Microsoft.Build.BuildEngine.Project GetLoadedProject (string projectFullFileName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.BuildEngine.Project</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFullFileName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the <see cref="T:Microsoft.Build.BuildEngine.Project" /> object that is associated with the specified project file.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:Microsoft.Build.BuildEngine.Project" /> object that associated with the specified project file. If no <see cref="T:Microsoft.Build.BuildEngine.Project" /> object is associated with the specified project file, the method returns a null reference (Nothing in vbprvb).</para>
</returns>
<param name="projectFullFileName">
<attribution license="cc4" from="Microsoft" modified="false" />The fully qualified file path to the project file of the <see cref="T:Microsoft.Build.BuildEngine.Project" /> object.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GlobalEngine">
<MemberSignature Language="C#" Value="public static Microsoft.Build.BuildEngine.Engine GlobalEngine { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.BuildEngine.Engine</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the <see cref="T:Microsoft.Build.BuildEngine.Engine" /> that is global (shared) for this <see cref="T:System.AppDomain" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GlobalProperties">
<MemberSignature Language="C#" Value="public Microsoft.Build.BuildEngine.BuildPropertyGroup GlobalProperties { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.BuildEngine.BuildPropertyGroup</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Global properties are properties that are set by using the <system>/property</system> switch on the command line, or properties that are set by the integrated development environment (IDE) before a project is built. These global properties are applied to all projects that are built by using this <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a collection of the global properties for the project.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="OnlyLogCriticalEvents">
<MemberSignature Language="C#" Value="public bool OnlyLogCriticalEvents { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that indicates whether to only log critical events, such as warnings and errors, during the build.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RegisterLogger">
<MemberSignature Language="C#" Value="public void RegisterLogger (Microsoft.Build.Framework.ILogger logger);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="logger" Type="Microsoft.Build.Framework.ILogger" />
</Parameters>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When a logger is registered with the <see cref="T:Microsoft.Build.BuildEngine.Engine" />, it receives all build events.</para>
<para>To unregister loggers, use the <see cref="M:Microsoft.Build.BuildEngine.Engine.UnregisterAllLoggers" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Registers the specified logger with the <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</para>
</summary>
<param name="logger">
<attribution license="cc4" from="Microsoft" modified="false" />The logger to associate with the <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UnloadAllProjects">
<MemberSignature Language="C#" Value="public void UnloadAllProjects ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes all references to <see cref="T:Microsoft.Build.BuildEngine.Project" /> objects from the <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UnloadProject">
<MemberSignature Language="C#" Value="public void UnloadProject (Microsoft.Build.BuildEngine.Project project);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="project" Type="Microsoft.Build.BuildEngine.Project" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes the reference to the specified <see cref="T:Microsoft.Build.BuildEngine.Project" /> from the <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</para>
</summary>
<param name="project">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.Project" /> to remove from the <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UnregisterAllLoggers">
<MemberSignature Language="C#" Value="public void UnregisterAllLoggers ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:Microsoft.Build.BuildEngine.Engine.UnregisterAllLoggers" /> method calls the <see cref="M:Microsoft.Build.Framework.ILogger.Shutdown" /> method on every registered logger before unregistering each of them from the <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Unregisters all loggers from the <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public static Version Version { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Version</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the version of the <see cref="T:Microsoft.Build.BuildEngine.Engine" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
Reference in New Issue View Git Blame Copy Permalink