Share via


ModuleMetadata.GetReference(DocumentationProvider, String, String) Method

Definition

Creates a reference to the module metadata.

public Microsoft.CodeAnalysis.PortableExecutableReference GetReference(Microsoft.CodeAnalysis.DocumentationProvider documentation = default, string filePath = default, string display = default);
public Microsoft.CodeAnalysis.PortableExecutableReference GetReference(Microsoft.CodeAnalysis.DocumentationProvider? documentation = default, string? filePath = default, string? display = default);
member this.GetReference : Microsoft.CodeAnalysis.DocumentationProvider * string * string -> Microsoft.CodeAnalysis.PortableExecutableReference
Public Function GetReference (Optional documentation As DocumentationProvider = Nothing, Optional filePath As String = Nothing, Optional display As String = Nothing) As PortableExecutableReference

Parameters

documentation
DocumentationProvider

Provider of XML documentation comments for the metadata symbols contained in the module.

filePath
String

Path describing the ___location of the metadata, or null if the metadata have no ___location.

display
String

Display string used in error messages to identity the reference.

Returns

A reference to the module metadata.

Applies to