ResolveComReference Class

  • Reference

Definition

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

Main class for the COM reference resolution task for .NET Core

This API supports the product infrastructure and is not intended to be used directly from your code.

public ref class ResolveComReference sealed : Microsoft::Build::Tasks::AppDomainIsolatedTaskExtension
public ref class ResolveComReference sealed : Microsoft::Build::Tasks::TaskExtension
public ref class ResolveComReference sealed : Microsoft::Build::Tasks::TaskRequiresFramework
public sealed class ResolveComReference : Microsoft.Build.Tasks.AppDomainIsolatedTaskExtension
public sealed class ResolveComReference : Microsoft.Build.Tasks.TaskExtension
public sealed class ResolveComReference : Microsoft.Build.Tasks.TaskRequiresFramework
type ResolveComReference = class
    inherit AppDomainIsolatedTaskExtension
type ResolveComReference = class
    inherit TaskExtension
type ResolveComReference = class
    inherit TaskRequiresFramework
Public NotInheritable Class ResolveComReference
Inherits AppDomainIsolatedTaskExtension
Public NotInheritable Class ResolveComReference
Inherits TaskExtension
Public NotInheritable Class ResolveComReference
Inherits TaskRequiresFramework
Inheritance
MarshalByRefObject
AppDomainIsolatedTask
AppDomainIsolatedTaskExtension
ResolveComReference
Inheritance
Object
Task
TaskExtension
ResolveComReference
Inheritance
Object
Task
TaskExtension
TaskRequiresFramework
ResolveComReference

Remarks

On a 64-bit machine, Framework64/<version>/msbuild cannot resolve COM objects registered as 32-bit components. For example, if you register a COM object with regsvr32 and then try to build a project targeting the x86 platform with Framework64/<version>/msbuild, the build is unable to resolve the COM object. If instead you build with Framework/<version>/msbuild, the build is able to resolve the COM object.

Constructors

ResolveComReference()

This API supports the product infrastructure and is not intended to be used directly from your code.

Initializes a new instance of the ResolveComReference class.

Properties

BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

(Inherited from AppDomainIsolatedTask)
BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

(Inherited from Task)
BuildEngine2

The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(Inherited from Task)
BuildEngine3

Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine4

Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine5

Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine6

Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine7

Retrieves the IBuildEngine7 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine8

Retrieves the IBuildEngine8 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine9

Retrieves the IBuildEngine9 version of the build engine interface provided by the host.

(Inherited from Task)
DelaySign

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a Boolean value that specifies whether the ResolveComReference task places the public key in the assembly (true) or fully signs the assembly (false).
EnvironmentVariables

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets an array of name-value pairs of environment variables that should be passed to the spawned tlbimp.exe and aximp.exe in addition to (or selectively overriding) the regular environment block.
ExecuteAsTool

This API supports the product infrastructure and is not intended to be used directly from your code.

Property to allow multitargeting of ResolveComReferences: If true, tlbimp.exe and aximp.exe from the appropriate target framework will be run out-of-proc to generate the necessary wrapper assemblies.
HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the LogErrorWithCodeFromResources(String, Object[]) method.

(Inherited from AppDomainIsolatedTask)
HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(Inherited from Task)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from AppDomainIsolatedTask)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from Task)
IncludeVersionInInteropName

This API supports the product infrastructure and is not intended to be used directly from your code.

When set to true, the typelib version will be included in the wrapper name. Default is false.
KeyContainer

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a container that holds a key pair.
KeyFile

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets an item that contains a key pair.
Log

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(Inherited from AppDomainIsolatedTaskExtension)
Log

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(Inherited from TaskExtension)
NoClassMembers

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a Boolean value that specifies whether to pass the PreventClassMembers flag to .tlb wrapper generation.
ResolvedAssemblyReferences

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the resolved assembly references.
ResolvedFiles

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the fully qualified files on disk that correspond to the physical locations of the type libraries that were provided as input to this task.
ResolvedModules

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the paths to the modules that were found.
SdkToolsPath

This API supports the product infrastructure and is not intended to be used directly from your code.

If ExecuteAsTool is true, this must be set to the SDK tools path for the framework version being targeted.
Silent

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a value that indicates whether messages or warnings are logged.
StateFile

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the cache file for COM component timestamps.
TargetFrameworkVersion

This API supports the product infrastructure and is not intended to be used directly from your code.

The project target framework version. Default is empty. which means there will be no filtering for the reference based on their target framework.
TargetProcessorArchitecture

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the name of the preferred target processor architecture, which is passed to the tlbimp.exe /machine flag after translation, for example x86, ia64, amd64 or msil.
TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Inherited from AppDomainIsolatedTask)
TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Inherited from Task)
TypeLibFiles

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the type library file path to COM references.
TypeLibNames

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the type library names to resolve.
WrapperOutputDirectory

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the location on disk where the generated interop assembly is placed.

Methods

Execute()

This API supports the product infrastructure and is not intended to be used directly from your code.

Task entry point.
Execute()

Task entry point.

(Inherited from TaskRequiresFramework)
InitializeLifetimeService()
Obsolete.

Overridden to give tasks deriving from this class infinite lease time. Otherwise we end up with a limited lease (5 minutes I think) and task instances can expire if they take long time processing.

(Inherited from AppDomainIsolatedTask)

Applies to