ResolveAssemblyReference Class

Definition

Namespace:

Microsoft.Build.Tasks

Assembly:

Microsoft.Build.Tasks.Core.dll

Package:

Microsoft.Build.Tasks.Core v17.11.4

Source:

ResolveAssemblyReference.cs

Given a list of assemblyFiles, determine the closure of all assemblyFiles that depend on those assemblyFiles including second and nth-order dependencies too.

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

public ref class ResolveAssemblyReference : Microsoft::Build::Tasks::TaskExtension, Microsoft::Build::Framework::IIncrementalTask

public class ResolveAssemblyReference : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.IIncrementalTask

type ResolveAssemblyReference = class
    inherit TaskExtension
    interface IIncrementalTask

Public Class ResolveAssemblyReference
Inherits TaskExtension
Implements IIncrementalTask

Inheritance

Object

Task

TaskExtension

ResolveAssemblyReference

Implements

IIncrementalTask

Constructors

ResolveAssemblyReference()

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

Properties

AllowedAssemblyExtensions	This API supports the product infrastructure and is not intended to be used directly from your code. [default=.exe;.dll] These are the assembly extensions that will be considered during references resolution.
AllowedRelatedFileExtensions	This API supports the product infrastructure and is not intended to be used directly from your code. [default=.pdb;.xml] These are the extensions that will be considered when looking for related files.
AppConfigFile	This API supports the product infrastructure and is not intended to be used directly from your code. If this file name is passed in, then we parse it as an app.config file and extract bindingRedirect mappings. These mappings are used in the dependency calculation process to remap versions of assemblies. If this parameter is passed in, then AutoUnify must be false, otherwise error.
Assemblies	This API supports the product infrastructure and is not intended to be used directly from your code. These can either be simple fusion names like: System or strong names like System, Version=2.0.3500.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 These names will be resolved into full paths and all dependencies will be found. Optional attributes are: bool Private [default=true] -- means 'CopyLocal' string HintPath [default=''] -- location of file name to consider as a reference, used when {HintPathFromItem} is one of the paths in SearchPaths. bool SpecificVersion [default=absent] -- when true, the exact fusionname in the Include must be matched. when false, any assembly with the same simple name will be a match. when absent, then look at the value in Include. If its a simple name then behave as if specific version=false. If its a strong name then behave as if specific version=true. string ExecutableExtension [default=absent] -- when present, the resolved assembly must have this extension. when absent, .dll is considered and then .exe for each directory looked at. string SubType -- only items with empty SubTypes will be considered. Items with non-empty subtypes will be ignored. string AssemblyFolderKey [default=absent] -- supported for legacy AssemblyFolder resolution. This key can have a value like 'hklm\vendor folder'. When set, only this particular assembly folder key will be used. This is to support the scenario in VSWhidey#357946 in which there are multiple side-by-side libraries installed and the user wants to pick an exact version. bool EmbedInteropTyeps [default=absent] -- when true, we should treat this assembly as if it has no dependencies and should be completely embedded into the target assembly.
AssemblyFiles	This API supports the product infrastructure and is not intended to be used directly from your code. A list of fully qualified paths-to-assemblyFiles to find dependencies for. Optional attributes are: bool Private [default=true] -- means 'CopyLocal' string FusionName -- the simple or strong fusion name for this item. If this attribute is present it can save time since the assembly file won't need to be opened to get the fusion name. bool ExternallyResolved [default=false] -- indicates that the reference and its dependencies are resolved by an external system (commonly from nuget assets) and so several steps can be skipped as an optimization: finding dependencies, satellite assemblies, etc.
AssemblyInformationCacheOutputPath	If not null, serializes information about AssemblyFiles inputs to the named file. This overrides the usual outputs, so do not use this unless you are building an SDK with many references.
AssemblyInformationCachePaths	If not null, uses this set of caches as inputs if RAR cannot find the usual cache in the obj folder. Typically used for demos and first-run scenarios.
AutoUnify	This API supports the product infrastructure and is not intended to be used directly from your code. [default=false] This parameter is used for building assemblies, such as DLLs, which cannot have a normal App.Config file. When true, the resulting dependency graph is automatically treated as if there were an App.Config file passed in to the AppConfigFile parameter. This virtual App.Config file has a bindingRedirect entry for each conflicting set of assemblies such that the highest version assembly is chosen. A consequence of this is that there will never be a warning about conflicting assemblies because every conflict will have been resolved. When true, each distinct remapping will result in a high priority comment indicating the old and new versions and the fact that this was done automatically because AutoUnify was true. When true, the AppConfigFile parameter should be empty. Otherwise, it's an error. When false, no assembly version remapping will occur automatically. When two versions of an assembly are present, there will be a warning. When false, each distinct conflict between different versions of the same assembly will result in a high priority comment. After all of these comments are displayed, there will be a single warning with a unique error code and text that reads "Found conflicts between different versions of reference and dependent assemblies".
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)
CandidateAssemblyFiles	This API supports the product infrastructure and is not intended to be used directly from your code. A list of assembly files that can be part of the search and resolution process. These must be absolute filenames, or project-relative filenames. Assembly files in this list will be considered when SearchPaths contains {CandidateAssemblyFiles} as one of the paths to consider.
CopyLocalDependenciesWhenParentReferenceInGac	This API supports the product infrastructure and is not intended to be used directly from your code. When determining if a dependency should be copied locally one of the checks done is to see if the parent reference in the project file has the Private metadata set or not. If that metadata is set then We will use that for the dependency as well. However, if the metadata is not set then the dependency will go through the same checks as the parent reference. One of these checks is to see if the reference is in the GAC. If a reference is in the GAC then we will not copy it locally as it is assumed it will be in the gac on the target machine as well. However this only applies to that specific reference and not its dependencies. This means a reference in the project file may be copy local false due to it being in the GAC but the dependencies may still be copied locally because they are not in the GAC. This is the default behavior for RAR and causes the default value for this property to be true. When this property is false we will still check project file references to see if they are in the GAC and set their copy local state as appropriate. However for dependencies we will not only check to see if they are in the GAC but we will also check to see if the parent reference from the project file is in the GAC. If the parent reference from the project file is in the GAC then we will not copy the dependency locally. NOTE: If there are multiple parent reference and ANY of them does not come from the GAC then we will set copy local to true.
CopyLocalFiles	This API supports the product infrastructure and is not intended to be used directly from your code. Returns every file in ResolvedFiles+ResolvedDependencyFiles+RelatedFiles+SatelliteFiles+ScatterFiles+SatelliteAssemblyFiles that have CopyLocal flags set to 'true'.
DependsOnNETStandard	Whether the assembly or any of its primary references depends on netstandard
DependsOnSystemRuntime	Whether the assembly or any of its primary references depends on system.runtime. (Aka needs Facade references to resolve duplicate types)
DoNotCopyLocalIfInGac	[default=false] Enables legacy mode for CopyLocal determination. If true, referenced assemblies will not be copied locally if they are found in the GAC. If false, assemblies will be copied locally unless they were found only in the GAC.
FailIfNotIncremental
FilesWritten	This API supports the product infrastructure and is not intended to be used directly from your code. The names of all files written to disk.
FindDependencies	This API supports the product infrastructure and is not intended to be used directly from your code. If set, then dependencies will be found. Otherwise, only Primary references will be resolved. Default is true.
FindDependenciesOfExternallyResolvedReferences	Force dependencies to be walked even when a reference is marked with ExternallyResolved=true metadata.
FindRelatedFiles	This API supports the product infrastructure and is not intended to be used directly from your code. If set, then related files (.pdbs and .xmls) will be found. Default is true.
FindSatellites	This API supports the product infrastructure and is not intended to be used directly from your code. If set, then satellites will be found. Default is true.
FindSerializationAssemblies	This API supports the product infrastructure and is not intended to be used directly from your code. If set, then serialization assemblies will be found. Default is true.
FullFrameworkAssemblyTables	This API supports the product infrastructure and is not intended to be used directly from your code. A list of XML files that contain the full framework for the profile. Normally nothing is passed in here, this is for the cases where the location of the xml file for the full framework is not under a RedistList folder. Format of the file is like: <FileList Redist="MatchingRedistListName"><File AssemblyName="System" Version="2.0.0.0" PublicKeyToken="b77a5c561934e089" Culture="neutral" ProcessorArchitecture="MSIL" FileVersion="2.0.40824.0" InGAC="true"></File> etc.</FileList> Items in this list must specify the "FrameworkDirectory" metadata to associate an redist list with a particular framework directory. If the association is not made an error will be logged. The reason is, The logic in rar assumes if a FrameworkDirectory is not set it will use the target framework directory.
FullFrameworkFolders	This API supports the product infrastructure and is not intended to be used directly from your code. Set of folders which containd a RedistList directory which represent the full framework for a given client profile. An example would be %programfiles%\reference assemblies\microsoft\framework\v4.0
FullTargetFrameworkSubsetNames	This API supports the product infrastructure and is not intended to be used directly from your code. Provide a set of names which if seen in the TargetFrameworkSubset list will cause the ignoring of TargetFrameworkSubsets. Full, Complete
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 Task)
IgnoreDefaultInstalledAssemblySubsetTables	This API supports the product infrastructure and is not intended to be used directly from your code. [default=false] Boolean property to control whether or not the task should look for and use additional installed assembly subset tables (a.k.a Subset Lists) found in the SubsetList directory underneath the provided TargetFrameworkDirectories.
IgnoreDefaultInstalledAssemblyTables	This API supports the product infrastructure and is not intended to be used directly from your code. [default=false] Boolean property to control whether or not the task should look for and use additional installed assembly tables (a.k.a Redist Lists) found in the RedistList directory underneath the provided TargetFrameworkDirectories.
IgnoreTargetFrameworkAttributeVersionMismatch	This API supports the product infrastructure and is not intended to be used directly from your code. Should the framework attribute be ignored when checking to see if an assembly is compatible with the targeted framework.
IgnoreVersionForFrameworkReferences	This API supports the product infrastructure and is not intended to be used directly from your code. If the primary reference is a framework assembly ignore its version information and actually resolve the framework assembly from the currently targeted framework.
InstalledAssemblySubsetTables	This API supports the product infrastructure and is not intended to be used directly from your code. A list of XML files that contain assemblies that are expected to be in the target subset Format of the file is like: <FileList Redist="ClientSubset"><File AssemblyName="System" Version="2.0.0.0" PublicKeyToken="b77a5c561934e089" Culture="neutral" ProcessorArchitecture="MSIL" FileVersion="2.0.40824.0" InGAC="true"></File> etc.</FileList> Items in this list may optionally specify the "FrameworkDirectory" metadata to associate an InstalledAssemblySubsetTable with a particular framework directory. If there is only a single TargetFrameworkDirectories element, then any items in this list missing the "FrameworkDirectory" metadata will be treated as though this metadata is set to the lone (unique) value passed to TargetFrameworkDirectories.
InstalledAssemblyTables	This API supports the product infrastructure and is not intended to be used directly from your code. A list of XML files that contain assemblies that are expected to be installed on the target machine. Format of the file is like: <FileList Redist="Microsoft-Windows-CLRCoreComp"><File AssemblyName="System" Version="2.0.0.0" PublicKeyToken="b77a5c561934e089" Culture="neutral" ProcessorArchitecture="MSIL" FileVersion="2.0.40824.0" InGAC="true"></File> etc.</FileList> When present, assemblies from this list will be candidates to automatically "unify" from prior versions up to the version listed in the XML. Also, assemblies with InGAC='true' will be considered prerequisites and will be CopyLocal='false' unless explicitly overridden. Items in this list may optionally specify the "FrameworkDirectory" metadata to associate an InstalledAssemblyTable with a particular framework directory. However, this setting will be ignored unless the Redist name begins with "Microsoft-Windows-CLRCoreComp". If there is only a single TargetFrameworkDirectories element, then any items in this list missing the "FrameworkDirectory" metadata will be treated as though this metadata is set to the lone (unique) value passed to TargetFrameworkDirectories.
LatestTargetFrameworkDirectories	This API supports the product infrastructure and is not intended to be used directly from your code. The list of directories which contain the redist lists for the most current framework which can be targeted on the machine. If this is not set Then we will looks for the highest framework installed on the machine for a given target framework identifier and use that.
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)
OutputUnresolvedAssemblyConflicts	If true, outputs any unresolved assembly conflicts (MSB3277) in UnresolvedAssemblyConflicts.
ProfileName	This API supports the product infrastructure and is not intended to be used directly from your code. Name of the target framework profile we are targeting. Eg. Client, Web, or Network
RelatedFiles	This API supports the product infrastructure and is not intended to be used directly from your code. Related files are files like intellidoc (.XML) and symbols (.PDB) that have the same base name as a reference. bool Primary [always false] - true if this assembly was passed in with Assemblies. bool CopyLocal - whether the given reference should be copied to the output directory.
ResolvedDependencyFiles	This API supports the product infrastructure and is not intended to be used directly from your code. A list of all n-th order paths-to-dependencies with the following attributes: bool CopyLocal - whether the given reference should be copied to the output directory. string FusionName - the fusion name for this dependency. string ResolvedFrom - the literal search path that this file was resolved from. bool IsRedistRoot - Whether or not this assembly is the representative for an entire redist. 'true' means the assembly is representative of an entire redist and should be indicated as an application dependency in an application manifest. 'false' means the assembly is internal to a redist and should not be part of the application manifest. string Redist - The name (if any) of the redist that contains this assembly. Does not include first order primary references--this list is in ResolvedFiles.
ResolvedFiles	This API supports the product infrastructure and is not intended to be used directly from your code. This is a list of all primary references resolved to full paths. bool CopyLocal - whether the given reference should be copied to the output directory. string FusionName - the fusion name for this dependency. string ResolvedFrom - the literal search path that this file was resolved from. bool IsRedistRoot - Whether or not this assembly is the representative for an entire redist. 'true' means the assembly is representative of an entire redist and should be indicated as an application dependency in an application manifest. 'false' means the assembly is internal to a redist and should not be part of the application manifest. string Redist - The name (if any) of the redist that contains this assembly.
ResolvedSDKReferences	This API supports the product infrastructure and is not intended to be used directly from your code. A list of resolved SDK references which contain the sdk name, sdk location and the targeted configuration. These locations will only be searched if the reference has the SDKName metadata attached to it.
SatelliteFiles	This API supports the product infrastructure and is not intended to be used directly from your code. Any satellite files found. These will be CopyLocal=true iff the reference or dependency that caused this item to exist is CopyLocal=true. bool CopyLocal - whether the given reference should be copied to the output directory. string DestinationSubDirectory - the relative destination directory that this file should be copied to. This is mainly for satellites.
ScatterFiles	This API supports the product infrastructure and is not intended to be used directly from your code. Scatter files associated with one of the given assemblies. bool CopyLocal - whether the given reference should be copied to the output directory.
SearchPaths	This API supports the product infrastructure and is not intended to be used directly from your code. List of locations to search for assemblyFiles when resolving dependencies. The following types of things can be passed in here: (1) A plain old directory path. (2) {HintPathFromItem} -- Look at the HintPath attribute from the base item. This attribute must be a file name not a directory name. (3) {CandidateAssemblyFiles} -- Look at the files passed in through the CandidateAssemblyFiles parameter. (4) {Registry:AssemblyFoldersBase,RuntimeVersion,AssemblyFoldersSuffix} Where: _AssemblyFoldersBase_ = Software\Microsoft[.NetFramework | .NetCompactFramework] _RuntimeVersion_ = the runtime version property from the project file _AssemblyFoldersSuffix_ = [ PocketPC | SmartPhone | WindowsCE]\AssemblyFoldersEx Then look in the registry for keys with the following schema: [HKLM | HKCU]\SOFTWARE\MICROSOFT\.NetFramework\ v1.0.3705 AssemblyFoldersEx ControlVendor.GridControl.1.0: @Default = c:\program files\ControlVendor\grid control\1.0\bin @Description = Grid Control for .NET version 1.0 9466 @Default = c:\program files\ControlVendor\grid control\1.0sp1\bin @Description = SP1 for Grid Control for .NET version 1.0 The based registry key is composed as: [HKLM | HKCU]_AssemblyFoldersBase__RuntimeVersion__AssemblyFoldersSuffix_ (5) {AssemblyFolders} -- Use the VisualStudion 2003 .NET finding-assemblies-from-registry scheme. (6) {GAC} -- Look in the GAC. (7) {RawFileName} -- Consider the Include value to be an exact path and file name.
SerializationAssemblyFiles	This API supports the product infrastructure and is not intended to be used directly from your code. Any XML serialization assemblies found. These will be CopyLocal=true iff the reference or dependency that caused this item to exist is CopyLocal=true. bool CopyLocal - whether the given reference should be copied to the output directory.
Silent	This API supports the product infrastructure and is not intended to be used directly from your code. If set, then don't log any messages to the screen. Default is false.
StateFile	This API supports the product infrastructure and is not intended to be used directly from your code. An optional file name that indicates where to save intermediate build state for this task. If not specified, then no inter-build caching will occur.
SuggestedRedirects	This API supports the product infrastructure and is not intended to be used directly from your code. Regardless of the value of AutoUnify, returns one item for every distinct conflicting assembly identity--including culture and PKT--that was found that did not have a suitable bindingRedirect entry in the ApplicationConfigurationFile. Each returned ITaskItem will have the following values: ItemSpec - the full fusion name of the assembly family with empty version=0.0.0.0 MaxVersion - the maximum version number.
SupportsBindingRedirectGeneration	This is true if the project type supports "AutoGenerateBindingRedirects" (currently only for EXE projects).
TargetedRuntimeVersion	This API supports the product infrastructure and is not intended to be used directly from your code. What is the runtime we are targeting, is it 2.0.57027 or anotherone, It can have a v or not prefixed onto it.
TargetFrameworkDirectories	This API supports the product infrastructure and is not intended to be used directly from your code. Path to the target frameworks directory. Required to figure out CopyLocal status for resulting items. If not present, then no resulting items will be deemed CopyLocal='true' unless they explicity have a Private='true' attribute on their source item.
TargetFrameworkMoniker	This API supports the product infrastructure and is not intended to be used directly from your code. The target framework moniker we are targeting if any. This is used for logging purposes. Default is empty.
TargetFrameworkMonikerDisplayName	This API supports the product infrastructure and is not intended to be used directly from your code. The display name of the target framework moniker, if any. This is only for logging.
TargetFrameworkSubsets	This API supports the product infrastructure and is not intended to be used directly from your code. List of target framework subset names which will be searched for in the target framework directories
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. The preferred target processor architecture. Used for resolving {GAC} references. Should be like x86, IA64 or AMD64. This is the order of preference: (1) Assemblies in the GAC that match the supplied ProcessorArchitecture. (2) Assemblies in the GAC that have ProcessorArchitecture=MSIL (3) Assemblies in the GAC that have no ProcessorArchitecture. If absent, then only consider assemblies in the GAC that have ProcessorArchitecture==MSIL or no ProcessorArchitecture (these are pre-Whidbey assemblies).
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)
UnresolvedAssemblyConflicts	If OutputUnresolvedAssemblyConflicts then a list of information about unresolved conflicts that normally would have been outputted in MSB3277. Otherwise empty.
UnresolveFrameworkAssembliesFromHigherFrameworks	If set to true, it forces to unresolve framework assemblies with versions higher or equal the version of the target framework, regardless of the target framework
WarnOrErrorOnTargetArchitectureMismatch	This API supports the product infrastructure and is not intended to be used directly from your code. If there is a mismatch between the targetprocessor architecture and the architecture of a primary reference. When this is error, an error will be logged. When this is warn, if there is a mismatch between the targetprocessor architecture and the architecture of a primary reference a warning will be logged. When this is none, no error or warning will be logged.

Methods

Execute()

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