Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

164 lines
8.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="ProjectStartedEventArgs" FullName="Microsoft.Build.Framework.ProjectStartedEventArgs">
<TypeSignature Language="C#" Value="public class ProjectStartedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Build.Framework.BuildStatusEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>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</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.ProjectStarted" /> event. </para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ProjectStartedEventArgs ();" />
<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.Framework.ProjectStartedEventArgs" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProjectStartedEventArgs (string message, string helpKeyword, string projectFile, string targetNames, System.Collections.IEnumerable properties, System.Collections.IEnumerable items);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="message" Type="System.String" />
<Parameter Name="helpKeyword" Type="System.String" />
<Parameter Name="projectFile" Type="System.String" />
<Parameter Name="targetNames" Type="System.String" />
<Parameter Name="properties" Type="System.Collections.IEnumerable" />
<Parameter Name="items" Type="System.Collections.IEnumerable" />
</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.Framework.ProjectStartedEventArgs" /> class with the specified values.</para>
</summary>
<param name="message">
<attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param>
<param name="helpKeyword">
<attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param>
<param name="projectFile">
<attribution license="cc4" from="Microsoft" modified="false" />The project file name.</param>
<param name="targetNames">
<attribution license="cc4" from="Microsoft" modified="false" />The targets to be built.</param>
<param name="properties">
<attribution license="cc4" from="Microsoft" modified="false" />A list of properties</param>
<param name="items">
<attribution license="cc4" from="Microsoft" modified="false" />A list of items.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Items">
<MemberSignature Language="C#" Value="public System.Collections.IEnumerable Items { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IEnumerable</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The items and metadata accessed through <see cref="P:Microsoft.Build.Framework.ProjectStartedEventArgs.Items" /> are kept up-to-date and can be enumerated throughout the build of the project. However, changing an item in this list will not affect the build process.</para>
<block subset="none" type="note">
<para>This property does not work with multi-proc builds. To get proper results, you can turn off multi-proc building by specifying /m:1 (which is the default).</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the list of items for the event.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ProjectFile">
<MemberSignature Language="C#" Value="public string ProjectFile { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</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 project file associated with the event.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public System.Collections.IEnumerable Properties { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IEnumerable</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The property names and values accessed through <see cref="P:Microsoft.Build.Framework.ProjectStartedEventArgs.Properties" /> are kept up-to-date and can be enumerated throughout the build of the project. However, changing a property in this list will not affect the build process.</para>
<block subset="none" type="note">
<para>This property does not work with multi-proc builds. To get proper results, you can either turn off multi-proc building by specifying /m:1 (which is the default), or you can work around the limitation by setting an environment variable. For example, setting MSBuildForwardPropertiesFromChild=configuration;platform forwards the "configuration" and "platform" properties from the child nodes. Unless this environment variable is defined, nothing will be forwarded. For more information, see <format type="text/html"><a href="7f9e4469-8865-4b59-aab3-3ff26bd36e77">How To: Use Environment Variables in a Build</a></format>.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the list of properties for the event.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TargetNames">
<MemberSignature Language="C#" Value="public string TargetNames { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</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 list of targets to be built in the project.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>