MetadataReference.CreateFromFile Metodo

Definizione

Spazio dei nomi:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Pacchetto:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

MetadataReference.cs

Crea un riferimento a un assembly o a un modulo autonomo archiviato in un file. Legge il contenuto del file in memoria.

public static Microsoft.CodeAnalysis.PortableExecutableReference CreateFromFile (string path, Microsoft.CodeAnalysis.MetadataReferenceProperties properties = default, Microsoft.CodeAnalysis.DocumentationProvider? documentation = default);

static member CreateFromFile : string * Microsoft.CodeAnalysis.MetadataReferenceProperties * Microsoft.CodeAnalysis.DocumentationProvider -> Microsoft.CodeAnalysis.PortableExecutableReference

Public Shared Function CreateFromFile (path As String, Optional properties As MetadataReferenceProperties = Nothing, Optional documentation As DocumentationProvider = Nothing) As PortableExecutableReference

Parametri

path

String

Percorso del file di assembly.

properties

MetadataReferenceProperties

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

documentation

DocumentationProvider

Fornisce la documentazione XML per il simbolo trovato nel riferimento.

Restituisce

PortableExecutableReference

Eccezioni

ArgumentNullException

path è null.

ArgumentException

path non è valido.

IOException

Errore durante la lettura del file.

Commenti

Considerazioni sulle prestazioni:

È consigliabile usare o CreateFromFile(String) API CreateFromFile(String) quando si creano più riferimenti allo stesso file. Il riutilizzo dell'oggetto Metadata consente di condividere i dati tra questi riferimenti.

Il metodo legge con entusiasmo l'intero contenuto del file nell'heap nativo. Il blocco di memoria nativa viene rilasciato quando il riferimento risultante diventa non raggiungibile e GC lo raccoglie. Per ridurre il footprint di memoria del riferimento e/o gestire la durata in modo deterministico, usare CreateFromFile(String) per creare un IDisposable oggetto metadati e GetReference(DocumentationProvider, ImmutableArray<String>, Boolean, String, String) ottenere un riferimento.