MetadataReference.CreateFromAssembly Method

Reference

Definition

Namespace:: Microsoft.CodeAnalysis

Assembly:: Microsoft.CodeAnalysis.dll

Package:: Microsoft.CodeAnalysis.Common v3.0.0

Package:: Microsoft.CodeAnalysis.Common v3.1.0

Package:: Microsoft.CodeAnalysis.Common v3.10.0

Package:: Microsoft.CodeAnalysis.Common v3.11.0

Package:: Microsoft.CodeAnalysis.Common v3.2.0

Package:: Microsoft.CodeAnalysis.Common v3.2.1

Package:: Microsoft.CodeAnalysis.Common v3.3.1

Package:: Microsoft.CodeAnalysis.Common v3.4.0

Package:: Microsoft.CodeAnalysis.Common v3.5.0

Package:: Microsoft.CodeAnalysis.Common v3.6.0

Package:: Microsoft.CodeAnalysis.Common v3.7.0

Package:: Microsoft.CodeAnalysis.Common v3.8.0

Package:: Microsoft.CodeAnalysis.Common v3.9.0

Package:: Microsoft.CodeAnalysis.Common v4.0.1

Package:: Microsoft.CodeAnalysis.Common v4.1.0

Package:: Microsoft.CodeAnalysis.Common v4.12.0

Package:: Microsoft.CodeAnalysis.Common v4.2.0

Package:: Microsoft.CodeAnalysis.Common v4.3.1

Package:: Microsoft.CodeAnalysis.Common v4.4.0

Package:: Microsoft.CodeAnalysis.Common v4.5.0

Package:: Microsoft.CodeAnalysis.Common v4.6.0

Package:: Microsoft.CodeAnalysis.Common v4.7.0

Package:: Microsoft.CodeAnalysis.Common v4.8.0

Package:: Microsoft.CodeAnalysis.Common v4.9.2

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.

Overloads

CreateFromAssembly(Assembly)	Obsolete. Creates a reference to a loaded assembly.
CreateFromAssembly(Assembly, MetadataReferenceProperties, DocumentationProvider)	Obsolete. Creates a reference to a loaded assembly.

CreateFromAssembly(Assembly)

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Caution

Use CreateFromFile(assembly.Location) instead

Creates a reference to a loaded assembly.

public:
 static Microsoft::CodeAnalysis::MetadataReference ^ CreateFromAssembly(System::Reflection::Assembly ^ assembly);

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
[System.Obsolete("Use CreateFromFile(assembly.Location) instead", true)]
public static Microsoft.CodeAnalysis.MetadataReference CreateFromAssembly (System.Reflection.Assembly assembly);

[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]
[<System.Obsolete("Use CreateFromFile(assembly.Location) instead", true)>]
static member CreateFromAssembly : System.Reflection.Assembly -> Microsoft.CodeAnalysis.MetadataReference

Public Shared Function CreateFromAssembly (assembly As Assembly) As MetadataReference

Parameters

assembly: Assembly

Path to the module file.

Returns

MetadataReference

Attributes: EditorBrowsableAttribute ObsoleteAttribute

Exceptions

ArgumentNullException

assembly is null.

NotSupportedException

assembly is dynamic, doesn't have a location, or the platform doesn't support reading from the location.

Remarks

Performance considerations:

It is recommended to use CreateFromFile(String) API when creating multiple references to the same assembly. Reusing AssemblyMetadata object allows for sharing data across these references.

Applies to

CreateFromAssembly(Assembly, MetadataReferenceProperties, DocumentationProvider)

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Source:: MetadataReference.cs

Caution

Use CreateFromFile(assembly.Location) instead

Creates a reference to a loaded assembly.

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
[System.Obsolete("Use CreateFromFile(assembly.Location) instead", true)]
public static Microsoft.CodeAnalysis.MetadataReference CreateFromAssembly (System.Reflection.Assembly assembly, Microsoft.CodeAnalysis.MetadataReferenceProperties properties, Microsoft.CodeAnalysis.DocumentationProvider documentation = default);

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
[System.Obsolete("Use CreateFromFile(assembly.Location) instead", true)]
public static Microsoft.CodeAnalysis.MetadataReference CreateFromAssembly (System.Reflection.Assembly assembly, Microsoft.CodeAnalysis.MetadataReferenceProperties properties, Microsoft.CodeAnalysis.DocumentationProvider? documentation = default);

[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]
[<System.Obsolete("Use CreateFromFile(assembly.Location) instead", true)>]
static member CreateFromAssembly : System.Reflection.Assembly * Microsoft.CodeAnalysis.MetadataReferenceProperties * Microsoft.CodeAnalysis.DocumentationProvider -> Microsoft.CodeAnalysis.MetadataReference

Public Shared Function CreateFromAssembly (assembly As Assembly, properties As MetadataReferenceProperties, Optional documentation As DocumentationProvider = Nothing) As MetadataReference

Parameters

assembly: Assembly

Path to the module file.

properties: MetadataReferenceProperties

Reference properties (extern aliases, type embedding).

documentation: DocumentationProvider

Provides XML documentation for symbol found in the reference.

Returns

MetadataReference

Attributes: EditorBrowsableAttribute ObsoleteAttribute

Exceptions

ArgumentNullException

assembly is null.

ArgumentException

properties.Kind is not Assembly.

NotSupportedException

assembly is dynamic, doesn't have a location, or the platform doesn't support reading from the location.

Remarks

Performance considerations:

It is recommended to use CreateFromFile(String) API when creating multiple references to the same assembly. Reusing AssemblyMetadata object allows for sharing data across these references.

Applies to

Share via

MetadataReference.CreateFromAssembly Method

Definition

Overloads

CreateFromAssembly(Assembly)

Parameters

Returns

Exceptions

Remarks

Applies to

CreateFromAssembly(Assembly, MetadataReferenceProperties, DocumentationProvider)

Parameters

Returns

Exceptions

Remarks

Applies to

Additional resources