MetadataReference.CreateFromImage Metodo

Definizione

Spazio dei nomi:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Pacchetto:

Microsoft.CodeAnalysis.Common v4.9.2

Overload

CreateFromImage(IEnumerable<Byte>, MetadataReferenceProperties, DocumentationProvider, String)	Crea un riferimento a un assembly a modulo singolo o a un modulo autonomo archiviato in memoria.
CreateFromImage(ImmutableArray<Byte>, MetadataReferenceProperties, DocumentationProvider, String)	Crea un riferimento a un assembly a modulo singolo o a un modulo autonomo archiviato in memoria.

CreateFromImage(IEnumerable<Byte>, MetadataReferenceProperties, DocumentationProvider, String)

Source:

MetadataReference.cs

Crea un riferimento a un assembly a modulo singolo o a un modulo autonomo archiviato in memoria.

public static Microsoft.CodeAnalysis.PortableExecutableReference CreateFromImage (System.Collections.Generic.IEnumerable<byte> peImage, Microsoft.CodeAnalysis.MetadataReferenceProperties properties = default, Microsoft.CodeAnalysis.DocumentationProvider? documentation = default, string? filePath = default);

static member CreateFromImage : seq<byte> * Microsoft.CodeAnalysis.MetadataReferenceProperties * Microsoft.CodeAnalysis.DocumentationProvider * string -> Microsoft.CodeAnalysis.PortableExecutableReference

Public Shared Function CreateFromImage (peImage As IEnumerable(Of Byte), Optional properties As MetadataReferenceProperties = Nothing, Optional documentation As DocumentationProvider = Nothing, Optional filePath As String = Nothing) As PortableExecutableReference

Parametri

peImage

IEnumerable<Byte>

Immagine dell'assembly.

properties

MetadataReferenceProperties

Proprietà di riferimento (alias extern, incorporamento dei tipi, MetadataImageKind).

documentation

DocumentationProvider

Fornisce la documentazione XML per il simbolo trovato nel riferimento.

filePath

String

Percorso facoltativo che descrive la posizione dei metadati. Il file non deve esistere su disco. Il percorso è opaco al compilatore.

Restituisce

PortableExecutableReference

Eccezioni

ArgumentNullException

peImage è null.

Commenti

Considerazioni sulle prestazioni:

È consigliabile usare o CreateFromImage(IEnumerable<Byte>) API CreateFromImage(IEnumerable<Byte>) quando si creano più riferimenti agli stessi metadati. Il riutilizzo dell'oggetto Metadata per creare più riferimenti consente di condividere i dati tra questi riferimenti.

Il metodo crea una copia dei dati e la aggiunge. Per evitare di creare una copia, usare un overload che accetta un oggetto ImmutableArray<T>. La memoria bloccata viene rilasciata quando il riferimento risultante diventa non raggiungibile e GC lo raccoglie. Per controllare la durata della memoria aggiunta in modo deterministico, usare CreateFromStream(Stream, PEStreamOptions) per creare un IDisposable oggetto metadati e GetReference(DocumentationProvider, ImmutableArray<String>, Boolean, String, String) ottenere un riferimento.

CreateFromImage(ImmutableArray<Byte>, MetadataReferenceProperties, DocumentationProvider, String)

Source:

MetadataReference.cs

Crea un riferimento a un assembly a modulo singolo o a un modulo autonomo archiviato in memoria.

public static Microsoft.CodeAnalysis.PortableExecutableReference CreateFromImage (System.Collections.Immutable.ImmutableArray<byte> peImage, Microsoft.CodeAnalysis.MetadataReferenceProperties properties = default, Microsoft.CodeAnalysis.DocumentationProvider? documentation = default, string? filePath = default);

static member CreateFromImage : System.Collections.Immutable.ImmutableArray<byte> * Microsoft.CodeAnalysis.MetadataReferenceProperties * Microsoft.CodeAnalysis.DocumentationProvider * string -> Microsoft.CodeAnalysis.PortableExecutableReference

Public Shared Function CreateFromImage (peImage As ImmutableArray(Of Byte), Optional properties As MetadataReferenceProperties = Nothing, Optional documentation As DocumentationProvider = Nothing, Optional filePath As String = Nothing) As PortableExecutableReference

Parametri

peImage

ImmutableArray<Byte>

Immagine dell'assembly.

properties

MetadataReferenceProperties

Proprietà di riferimento (alias extern, incorporamento dei tipi, MetadataImageKind).

documentation

DocumentationProvider

Fornisce la documentazione XML per il simbolo trovato nel riferimento.

filePath

String

Percorso facoltativo che descrive la posizione dei metadati. Il file non deve esistere su disco. Il percorso è opaco al compilatore.

Restituisce

PortableExecutableReference

Eccezioni

ArgumentNullException

peImage è null.

Commenti

Considerazioni sulle prestazioni:

È consigliabile usare o CreateFromImage(ImmutableArray<Byte>) API CreateFromImage(ImmutableArray<Byte>) quando si creano più riferimenti agli stessi metadati. Il riutilizzo dell'oggetto Metadata per creare più riferimenti consente di condividere i dati tra questi riferimenti.

Il metodo aggiunge peImage nell'heap gestito. La memoria bloccata viene rilasciata quando il riferimento risultante diventa non raggiungibile e GC lo raccoglie. Per controllare la durata della memoria aggiunta in modo deterministico, usare CreateFromImage(ImmutableArray<Byte>) per creare un IDisposable oggetto metadati e GetReference(DocumentationProvider, ImmutableArray<String>, Boolean, String, String) ottenere un riferimento.

Il metodo crea un riferimento a un assembly a modulo singolo. Per creare un riferimento a un assembly multimodulo o a un modulo autonomo, usare CreateFromImage(ImmutableArray<Byte>) e GetReference(DocumentationProvider, String, String).