BuildEventContext.xml

<Type Name="BuildEventContext" FullName="Microsoft.Build.Framework.BuildEventContext">
  <TypeSignature Language="C#" Value="public class BuildEventContext" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit BuildEventContext extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Build.Framework.BuildEventContext" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Build.Framework</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Provides contextual location information for build events.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 <xref:Microsoft.Build.Framework.BuildEventContext> is especially useful in multiprocessor environments.  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public BuildEventContext (int nodeId, int targetId, int projectContextId, int taskId);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 nodeId, int32 targetId, int32 projectContextId, int32 taskId) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="nodeId" Type="System.Int32" />
        <Parameter Name="targetId" Type="System.Int32" />
        <Parameter Name="projectContextId" Type="System.Int32" />
        <Parameter Name="taskId" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="nodeId">The node ID of the build event.</param>
        <param name="targetId">The target ID of the build event.</param>
        <param name="projectContextId">The project ID of the build event.</param>
        <param name="taskId">The task ID of the build event.</param>
        <summary>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildEventContext" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public BuildEventContext (int nodeId, int projectInstanceId, int projectContextId, int targetId, int taskId);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 nodeId, int32 projectInstanceId, int32 projectContextId, int32 targetId, int32 taskId) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="nodeId" Type="System.Int32" />
        <Parameter Name="projectInstanceId" Type="System.Int32" />
        <Parameter Name="projectContextId" Type="System.Int32" />
        <Parameter Name="targetId" Type="System.Int32" />
        <Parameter Name="taskId" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="nodeId">The node ID of the build event.</param>
        <param name="projectInstanceId">The project instance ID of the build event.</param>
        <param name="projectContextId">The project ID of the build event.</param>
        <param name="targetId">The target ID of the build event.</param>
        <param name="taskId">The task ID of the build event.</param>
        <summary>Constructs a BuildEventContext with a specified project instance id.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public BuildEventContext (int submissionId, int nodeId, int projectInstanceId, int projectContextId, int targetId, int taskId);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 submissionId, int32 nodeId, int32 projectInstanceId, int32 projectContextId, int32 targetId, int32 taskId) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.BuildEventContext.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="submissionId" Type="System.Int32" />
        <Parameter Name="nodeId" Type="System.Int32" />
        <Parameter Name="projectInstanceId" Type="System.Int32" />
        <Parameter Name="projectContextId" Type="System.Int32" />
        <Parameter Name="targetId" Type="System.Int32" />
        <Parameter Name="taskId" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="submissionId">The submission ID of the build event.</param>
        <param name="nodeId">The node ID of the build event.</param>
        <param name="projectInstanceId">The project instance ID of the build event.</param>
        <param name="projectContextId">The project ID of the build event.</param>
        <param name="targetId">The target ID of the build event.</param>
        <param name="taskId">The task ID of the build event.</param>
        <summary>Constructs a BuildEventContext with a specific submission id</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BuildRequestId">
      <MemberSignature Language="C#" Value="public long BuildRequestId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 BuildRequestId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.BuildEventContext.BuildRequestId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Retrieves the BuildRequest id. Note that this is not the same as the global request id on a BuildRequest or BuildResult.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.BuildEventContext.Equals(System.Object)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">The reference to compare.</param>
        <summary>Gets whether the references are the same.</summary>
        <returns>
          <see langword="true" /> if the references are equal, <see langword="false" /> otherwise.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.BuildEventContext.GetHashCode" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets a code comprised of the <see cref="P:Microsoft.Build.Framework.BuildEventContext.ProjectContextId" /> and the <see cref="P:Microsoft.Build.Framework.BuildEventContext.NodeId" />.</summary>
        <returns>An integer value representing the hash code.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Invalid">
      <MemberSignature Language="C#" Value="public static Microsoft.Build.Framework.BuildEventContext Invalid { get; }" />
      <MemberSignature Language="ILAsm" Value=".property class Microsoft.Build.Framework.BuildEventContext Invalid" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.BuildEventContext.Invalid" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Build.Framework.BuildEventContext</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets whether the context where the event occurred is valid.</summary>
        <value>
          <see langword="true" /> if the context is valid; <see langword="false" /> otherwise.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="InvalidNodeId">
      <MemberSignature Language="C#" Value="public const int InvalidNodeId = -2;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 InvalidNodeId = (-2)" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Build.Framework.BuildEventContext.InvalidNodeId" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>-2</MemberValue>
      <Docs>
        <summary>The node ID of the target the event was in when the event was triggered.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 An integer value representing the node ID.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="InvalidProjectContextId">
      <MemberSignature Language="C#" Value="public const int InvalidProjectContextId = -2;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 InvalidProjectContextId = (-2)" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Build.Framework.BuildEventContext.InvalidProjectContextId" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>-2</MemberValue>
      <Docs>
        <summary>The project ID of the target the event was in when the event was triggered.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="InvalidProjectInstanceId">
      <MemberSignature Language="C#" Value="public const int InvalidProjectInstanceId = -1;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 InvalidProjectInstanceId = (-1)" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Build.Framework.BuildEventContext.InvalidProjectInstanceId" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>-1</MemberValue>
      <Docs>
        <summary>The project instance ID of the target the event was in when the event was triggered.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="InvalidSubmissionId">
      <MemberSignature Language="C#" Value="public const int InvalidSubmissionId = -1;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 InvalidSubmissionId = (-1)" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Build.Framework.BuildEventContext.InvalidSubmissionId" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>-1</MemberValue>
      <Docs>
        <summary>The submission ID of the target the event was in when the event was triggered.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="InvalidTargetId">
      <MemberSignature Language="C#" Value="public const int InvalidTargetId = -1;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 InvalidTargetId = (-1)" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Build.Framework.BuildEventContext.InvalidTargetId" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>-1</MemberValue>
      <Docs>
        <summary>The name of the target the event was in when the event was triggered.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="InvalidTaskId">
      <MemberSignature Language="C#" Value="public const int InvalidTaskId = -1;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 InvalidTaskId = (-1)" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Build.Framework.BuildEventContext.InvalidTaskId" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>-1</MemberValue>
      <Docs>
        <summary>The task ID of the target the event was in when the event was triggered.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NodeId">
      <MemberSignature Language="C#" Value="public int NodeId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 NodeId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.BuildEventContext.NodeId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the node ID where the event occurred.</summary>
        <value>An integer value representing the node ID.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Equality">
      <MemberSignature Language="C#" Value="public static bool op_Equality (Microsoft.Build.Framework.BuildEventContext left, Microsoft.Build.Framework.BuildEventContext right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(class Microsoft.Build.Framework.BuildEventContext left, class Microsoft.Build.Framework.BuildEventContext right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.BuildEventContext.op_Equality(Microsoft.Build.Framework.BuildEventContext,Microsoft.Build.Framework.BuildEventContext)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Microsoft.Build.Framework.BuildEventContext" />
        <Parameter Name="right" Type="Microsoft.Build.Framework.BuildEventContext" />
      </Parameters>
      <Docs>
        <param name="left">Left hand side operand</param>
        <param name="right">Right hand side operand</param>
        <summary>Override == so the equals comparison using this operator will be the same as .Equals</summary>
        <returns>True if the object values are identical, false if they are not identical</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Inequality">
      <MemberSignature Language="C#" Value="public static bool op_Inequality (Microsoft.Build.Framework.BuildEventContext left, Microsoft.Build.Framework.BuildEventContext right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(class Microsoft.Build.Framework.BuildEventContext left, class Microsoft.Build.Framework.BuildEventContext right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.BuildEventContext.op_Inequality(Microsoft.Build.Framework.BuildEventContext,Microsoft.Build.Framework.BuildEventContext)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Microsoft.Build.Framework.BuildEventContext" />
        <Parameter Name="right" Type="Microsoft.Build.Framework.BuildEventContext" />
      </Parameters>
      <Docs>
        <param name="left">Left hand side operand</param>
        <param name="right">Right hand side operand</param>
        <summary>Override != so the equals comparison using this operator will be the same as ! Equals</summary>
        <returns>True if the object values are not identical, false if they are identical</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ProjectContextId">
      <MemberSignature Language="C#" Value="public int ProjectContextId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 ProjectContextId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.BuildEventContext.ProjectContextId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the ID of the project where the event occurred.</summary>
        <value>An integer value representing the project ID.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ProjectInstanceId">
      <MemberSignature Language="C#" Value="public int ProjectInstanceId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 ProjectInstanceId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.BuildEventContext.ProjectInstanceId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Retrieves the project instance id.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SubmissionId">
      <MemberSignature Language="C#" Value="public int SubmissionId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 SubmissionId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.BuildEventContext.SubmissionId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Retrieves the Submission id.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TargetId">
      <MemberSignature Language="C#" Value="public int TargetId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 TargetId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.BuildEventContext.TargetId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the ID of the target where the event occurred.</summary>
        <value>An integer value representing the target ID.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TaskId">
      <MemberSignature Language="C#" Value="public int TaskId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 TaskId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.BuildEventContext.TaskId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the ID of the task where the event occurred.</summary>
        <value>An integer value representing the task ID.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>