GraphBuildSubmission Class

Reference

Definition

Namespace:: Microsoft.Build.Graph

Assembly:: Microsoft.Build.dll

Package:: Microsoft.Build v16.11.0

Package:: Microsoft.Build v17.13.9

Source:: GraphBuildSubmission.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A GraphBuildSubmission represents a graph build request which has been submitted to the BuildManager for processing. It may be used to execute synchronous or asynchronous graph build requests and provides access to the results upon completion.

public ref class GraphBuildSubmission

public ref class GraphBuildSubmission : Microsoft::Build::Execution::BuildSubmissionBase<Microsoft::Build::Graph::GraphBuildRequestData ^, Microsoft::Build::Graph::GraphBuildResult ^>

public class GraphBuildSubmission

public class GraphBuildSubmission : Microsoft.Build.Execution.BuildSubmissionBase<Microsoft.Build.Graph.GraphBuildRequestData,Microsoft.Build.Graph.GraphBuildResult>

type GraphBuildSubmission = class

type GraphBuildSubmission = class
    inherit BuildSubmissionBase<GraphBuildRequestData, GraphBuildResult>

Public Class GraphBuildSubmission

Public Class GraphBuildSubmission
Inherits BuildSubmissionBase(Of GraphBuildRequestData, GraphBuildResult)

Inheritance: Object
GraphBuildSubmission

Inheritance: Object

BuildSubmissionBase

BuildSubmissionBase<GraphBuildRequestData,GraphBuildResult>
GraphBuildSubmission

Remarks

This class is thread-safe.

Fields

CompletionEvent	The completion event. (Inherited from BuildSubmissionBase)
CompletionInvoked	True if it has been invoked (Inherited from BuildSubmissionBase)

Properties

AsyncContext	The asynchronous context provided to ExecuteAsync(BuildSubmissionCompleteCallback, Object), if any.
BuildManager	The BuildManager with which this submission is associated.
BuildResult	The results of the build per graph node. Valid only after WaitHandle has become signalled.
IsCompleted	Returns true if this submission is complete.
SubmissionId	An ID uniquely identifying this request from among other submissions within the same build.
WaitHandle	A WaitHandle which will be signalled when the build is complete. Valid after Execute() or ExecuteAsync(BuildSubmissionCompleteCallback, Object) returns, otherwise null.

Methods

CheckForCompletion()	Determines if we are completely done with this submission and can complete it so the user may access results. (Inherited from BuildSubmissionBase<TRequestData,TResultData>)
CheckResultValidForCompletion(GraphBuildResult)
CheckResultValidForCompletion(TResultData)	(Inherited from BuildSubmissionBase<TRequestData,TResultData>)
CreateFailedResult(Exception)
Execute()	Starts the request and blocks until results are available.
ExecuteAsync(GraphBuildSubmissionCompleteCallback, Object)	Starts the request asynchronously and immediately returns control to the caller.
OnCompletition()	(Inherited from BuildSubmissionBase)

Applies to

Поделиться через