Share via

HostObjectInitializationStatus Enum

  • Reference

Definition

Namespace:
Microsoft.Build.Utilities
Assembly:
Microsoft.Build.Utilities.Core.dll
Assembly:
Microsoft.Build.Utilities.dll
Assemblies:
Microsoft.Build.Utilities.dll, Microsoft.Build.Utilities.v3.5.dll
Assembly:
Microsoft.Build.Utilities.v4.0.dll
Package:
Microsoft.Build.Utilities.Core v15.9.20
Package:
Microsoft.Build.Utilities.Core v16.11.0
Package:
Microsoft.Build.Utilities.Core v17.11.4
Source:
ToolTask.cs

The return value from InitializeHostObject. This enumeration defines what action the ToolTask should take next, after we've tried to initialize the host object.

public enum class HostObjectInitializationStatus
public enum HostObjectInitializationStatus
type HostObjectInitializationStatus = 
Public Enum HostObjectInitializationStatus
Inheritance
Enum
HostObjectInitializationStatus

Fields

NoActionReturnFailure 3

This means that some of the parameters being passed into the task are invalid, and the task should fail immediately.
NoActionReturnSuccess 2

This means that the host object is already up-to-date, and no further action is necessary.
UseAlternateToolToExecute 1

This means that either there is no host object available, or that the host object is not capable of supporting all of the features required for this build. Therefore, ToolTask should fallback to an alternate means of doing the build, such as invoking the command-line tool.
UseHostObjectToExecute 0

This means that there exists an appropriate host object for this task, it can support all of the parameters passed in, and it should be invoked to do the real work of the task.

Remarks

HostObjectInitializationStatus is the return type of the InitializeHostObject method of the ToolTask class.

Applies to