ModuleMetadata.GetReference(DocumentationProvider, String, String) Method
Definition
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.
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.PortableExecutableReferencePublic Function GetReference (Optional documentation As DocumentationProvider = Nothing, Optional filePath As String = Nothing, Optional display As String = Nothing) As PortableExecutableReferenceParameters
- 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.
