BuildSubmission Class
Definition
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 BuildSubmission represents a build request which has been submitted to the BuildManager for processing. It may be used to execute synchronous or asynchronous build requests and provides access to the results upon completion.
public ref class BuildSubmission
public ref class BuildSubmission : Microsoft::Build::Execution::BuildSubmissionBase<Microsoft::Build::Execution::BuildRequestData ^, Microsoft::Build::Execution::BuildResult ^>
public class BuildSubmission
public class BuildSubmission : Microsoft.Build.Execution.BuildSubmissionBase<Microsoft.Build.Execution.BuildRequestData,Microsoft.Build.Execution.BuildResult>
type BuildSubmission = class
type BuildSubmission = class
inherit BuildSubmissionBase<BuildRequestData, BuildResult>
Public Class BuildSubmission
Public Class BuildSubmission
Inherits BuildSubmissionBase(Of BuildRequestData, BuildResult)
- Inheritance
-
BuildSubmission
- Inheritance
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 result of the build. 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(BuildResult) | |
CheckResultValidForCompletion(TResultData) | (Inherited from BuildSubmissionBase<TRequestData,TResultData>) |
CreateFailedResult(Exception) | |
Execute() |
Starts the request and blocks until results are available. |
ExecuteAsync(BuildSubmissionCompleteCallback, Object) |
Starts the request asynchronously and immediately returns control to the caller. |
OnCompletition() |