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.

Represents metadata image reference.

public ref class MetadataReference abstract

public abstract class MetadataReference

type MetadataReference = class

Public MustInherit Class MetadataReference

Inheritance: Object
MetadataReference

Derived: Microsoft.CodeAnalysis.CompilationReference

Microsoft.CodeAnalysis.PortableExecutableReference

Microsoft.CodeAnalysis.UnresolvedMetadataReference

Remarks

Represents a logical location of the image, not the content of the image. The content might change in time. A snapshot is taken when the compiler queries the reference for its metadata.

Constructors

Name	Description
MetadataReference(MetadataReferenceProperties)

Properties

Name	Description
Display	Path or name used in error messages to identity the reference.
Properties

Methods

Name	Description
CreateFromAssembly(Assembly, MetadataReferenceProperties, DocumentationProvider)	Obsolete. Creates a reference to a loaded assembly.
CreateFromAssembly(Assembly)	Obsolete. Creates a reference to a loaded assembly.
CreateFromFile(String, MetadataReferenceProperties, DocumentationProvider)	Creates a reference to an assembly or standalone module stored in a file. Reads the content of the file into memory.
CreateFromImage(IEnumerable<Byte>, MetadataReferenceProperties, DocumentationProvider, String)	Creates a reference to a single-module assembly or a standalone module stored in memory.
CreateFromImage(ImmutableArray<Byte>, MetadataReferenceProperties, DocumentationProvider, String)	Creates a reference to a single-module assembly or a standalone module stored in memory.
CreateFromStream(Stream, MetadataReferenceProperties, DocumentationProvider, String)	Creates a reference to a single-module assembly or a stand-alone module from data in specified stream. Reads the content of the stream into memory and closes the stream upon return.
WithAliases(IEnumerable<String>)	Returns an instance of the reference with specified aliases.
WithAliases(ImmutableArray<String>)	Returns an instance of the reference with specified aliases.
WithEmbedInteropTypes(Boolean)	Returns an instance of the reference with specified interop types embedding.
WithProperties(MetadataReferenceProperties)	Returns an instance of the reference with specified properties, or this instance if properties haven't changed.

Applies to

Feedback

Was this page helpful?

URL: https://learn.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.metadatareference?view=roslyn-dotnet-5.0.0

⇱ MetadataReference Class (Microsoft.CodeAnalysis) | Microsoft Learn