FSharpCheckFileResults (F# Compiler Guide)

FSharpCheckFileResults Type

Namespace: FSharp.Compiler.CodeAnalysis
Assembly: FSharp.Compiler.Service.dll
Base Type: obj

A handle to the results of CheckFileInProject.

Instance members

Instance member	Description
`this.DependencyFiles` Full Usage: `this.DependencyFiles` Returns: `string[]`	Indicates the set of files which must be watched to accurately track changes that affect these results, Clients interested in reacting to updates to these files should watch these files and take actions as described in the documentation for compiler service. Returns: `string[]`
`this.Diagnostics` Full Usage: `this.Diagnostics` Returns: `FSharpDiagnostic[]`	The errors returned by parsing a source file. Returns: `FSharpDiagnostic[]`
`this.GenerateSignature` Full Usage: `this.GenerateSignature` Parameters: ?pageWidth : `int` Returns: `ISourceText option`	Lays out and returns the formatted signature for the typechecked file as source text. ?pageWidth : `int` Returns: `ISourceText option`
`this.GetAllUsesOfAllSymbolsInFile` Full Usage: `this.GetAllUsesOfAllSymbolsInFile` Parameters: ?cancellationToken : `CancellationToken` Returns: `FSharpSymbolUse seq`	Get all textual usages of all symbols throughout the file ?cancellationToken : `CancellationToken` Returns: `FSharpSymbolUse seq`
`this.GetDeclarationListInfo` Full Usage: `this.GetDeclarationListInfo` Parameters: parsedFileResults : `FSharpParseFileResults option` - If this is present, it is used to filter declarations based on location in the parse tree, specifically at 'open' declarations, 'inherit' of class or interface 'record field' locations and r.h.s. of 'range' operator a..b line : `int` - The line number where the completion is happening lineText : `string` - The text of the line where the completion is happening. This is only used to make a couple of adhoc corrections to completion accuracy (e.g. checking for "..") partialName : `PartialLongName` - Partial long name. QuickParse.GetPartialLongNameEx can be used to get it. ?getAllEntities : `unit -> AssemblySymbol list` - Function that returns all entities from current and referenced assemblies. ?completionContextAtPos : `pos * CompletionContext option` - Completion context for a particular position computed in advance. ?genBodyForOverriddenMeth : `bool` - A switch to determine whether to generate a default implementation body for overridden method when completing. Returns: `DeclarationListInfo`	Get the items for a declaration list parsedFileResults : `FSharpParseFileResults option` If this is present, it is used to filter declarations based on location in the parse tree, specifically at 'open' declarations, 'inherit' of class or interface 'record field' locations and r.h.s. of 'range' operator a..b line : `int` The line number where the completion is happening lineText : `string` The text of the line where the completion is happening. This is only used to make a couple of adhoc corrections to completion accuracy (e.g. checking for "..") partialName : `PartialLongName` Partial long name. QuickParse.GetPartialLongNameEx can be used to get it. ?getAllEntities : `unit -> AssemblySymbol list` Function that returns all entities from current and referenced assemblies. ?completionContextAtPos : `pos * CompletionContext option` Completion context for a particular position computed in advance. ?genBodyForOverriddenMeth : `bool` A switch to determine whether to generate a default implementation body for overridden method when completing. Returns: `DeclarationListInfo`
`this.GetDeclarationListSymbols` Full Usage: `this.GetDeclarationListSymbols` Parameters: parsedFileResults : `FSharpParseFileResults option` - If this is present, it is used to filter declarations based on location in the parse tree, specifically at 'open' declarations, 'inherit' of class or interface 'record field' locations and r.h.s. of 'range' operator a..b line : `int` - The line number where the completion is happening lineText : `string` - The text of the line where the completion is happening. This is only used to make a couple of adhoc corrections to completion accuracy (e.g. checking for "..") partialName : `PartialLongName` - Partial long name. QuickParse.GetPartialLongNameEx can be used to get it. ?getAllEntities : `unit -> AssemblySymbol list` - Function that returns all entities from current and referenced assemblies. ?genBodyForOverriddenMeth : `bool` - A switch to determine whether to generate a default implementation body for overridden method when completing. Returns: `FSharpSymbolUse list list`	Get the items for a declaration list in FSharpSymbol format parsedFileResults : `FSharpParseFileResults option` If this is present, it is used to filter declarations based on location in the parse tree, specifically at 'open' declarations, 'inherit' of class or interface 'record field' locations and r.h.s. of 'range' operator a..b line : `int` The line number where the completion is happening lineText : `string` The text of the line where the completion is happening. This is only used to make a couple of adhoc corrections to completion accuracy (e.g. checking for "..") partialName : `PartialLongName` Partial long name. QuickParse.GetPartialLongNameEx can be used to get it. ?getAllEntities : `unit -> AssemblySymbol list` Function that returns all entities from current and referenced assemblies. ?genBodyForOverriddenMeth : `bool` A switch to determine whether to generate a default implementation body for overridden method when completing. Returns: `FSharpSymbolUse list list`
`this.GetDeclarationLocation` Full Usage: `this.GetDeclarationLocation` Parameters: line : `int` - The line number where the information is being requested. colAtEndOfNames : `int` - The column number at the end of the identifiers where the information is being requested. lineText : `string` - The text of the line where the information is being requested. names : `string list` - The identifiers at the location where the information is being requested. ?preferFlag : `bool` - If not given, then get the location of the symbol. If false, then prefer the location of the corresponding symbol in the implementation of the file (rather than the signature if present). If true, prefer the location of the corresponding symbol in the signature of the file (rather than the implementation). Returns: `FindDeclResult`	Resolve the names at the given location to the declaration location of the corresponding construct. line : `int` The line number where the information is being requested. colAtEndOfNames : `int` The column number at the end of the identifiers where the information is being requested. lineText : `string` The text of the line where the information is being requested. names : `string list` The identifiers at the location where the information is being requested. ?preferFlag : `bool` If not given, then get the location of the symbol. If false, then prefer the location of the corresponding symbol in the implementation of the file (rather than the signature if present). If true, prefer the location of the corresponding symbol in the signature of the file (rather than the implementation). Returns: `FindDeclResult`
`this.GetDescription` Full Usage: `this.GetDescription` Parameters: symbol : `FSharpSymbol` - The symbol. inst : `(FSharpGenericParameter * FSharpType) list` - Generic arguments. displayFullName : `bool` - Display the symbol full name. range : `range` - The position. Returns: `ToolTipText`	Compute a formatted tooltip for the given symbol at position symbol : `FSharpSymbol` The symbol. inst : `(FSharpGenericParameter * FSharpType) list` Generic arguments. displayFullName : `bool` Display the symbol full name. range : `range` The position. Returns: `ToolTipText`
`this.GetDisplayContextForPos` Full Usage: `this.GetDisplayContextForPos` Parameters: cursorPos : `pos` Returns: `FSharpDisplayContext option`	Find the most precise display environment for the given line and column. cursorPos : `pos` Returns: `FSharpDisplayContext option`
`this.GetF1Keyword` Full Usage: `this.GetF1Keyword` Parameters: line : `int` - The line number where the information is being requested. colAtEndOfNames : `int` - The column number at the end of the identifiers where the information is being requested. lineText : `string` - The text of the line where the information is being requested. names : `string list` - The identifiers at the location where the information is being requested. Returns: `string option`	Compute the Visual Studio F1-help key identifier for the given location, based on name resolution results line : `int` The line number where the information is being requested. colAtEndOfNames : `int` The column number at the end of the identifiers where the information is being requested. lineText : `string` The text of the line where the information is being requested. names : `string list` The identifiers at the location where the information is being requested. Returns: `string option`
`this.GetFormatSpecifierLocationsAndArity` Full Usage: `this.GetFormatSpecifierLocationsAndArity` Returns: `(range * int)[]`	Get the locations of and number of arguments associated with format specifiers Returns: `(range * int)[]`
`this.GetKeywordTooltip` Full Usage: `this.GetKeywordTooltip` Parameters: names : `string list` - The keywords at the location where the information is being requested. Returns: `ToolTipText`	Compute a formatted tooltip for the given keywords names : `string list` The keywords at the location where the information is being requested. Returns: `ToolTipText`
`this.GetMethods` Full Usage: `this.GetMethods` Parameters: line : `int` - The line number where the information is being requested. colAtEndOfNames : `int` - The column number at the end of the identifiers where the information is being requested. lineText : `string` - The text of the line where the information is being requested. names : `string list option` - The identifiers at the location where the information is being requested. Returns: `MethodGroup`	Compute a set of method overloads to show in a dialog relevant to the given code location. line : `int` The line number where the information is being requested. colAtEndOfNames : `int` The column number at the end of the identifiers where the information is being requested. lineText : `string` The text of the line where the information is being requested. names : `string list option` The identifiers at the location where the information is being requested. Returns: `MethodGroup`
`this.GetMethodsAsSymbols` Full Usage: `this.GetMethodsAsSymbols` Parameters: line : `int` - The line number where the information is being requested. colAtEndOfNames : `int` - The column number at the end of the identifiers where the information is being requested. lineText : `string` - The text of the line where the information is being requested. names : `string list` - The identifiers at the location where the information is being requested. Returns: `FSharpSymbolUse list option`	Compute a set of method overloads to show in a dialog relevant to the given code location. The resulting method overloads are returned as symbols. line : `int` The line number where the information is being requested. colAtEndOfNames : `int` The column number at the end of the identifiers where the information is being requested. lineText : `string` The text of the line where the information is being requested. names : `string list` The identifiers at the location where the information is being requested. Returns: `FSharpSymbolUse list option`
`this.GetSemanticClassification` Full Usage: `this.GetSemanticClassification` Parameters: arg0 : `range option` Returns: `SemanticClassificationItem[]`	Get any extra colorization info that is available after the typecheck arg0 : `range option` Returns: `SemanticClassificationItem[]`
`this.GetSymbolUseAtLocation` Full Usage: `this.GetSymbolUseAtLocation` Parameters: line : `int` - The line number where the information is being requested. colAtEndOfNames : `int` - The column number at the end of the identifiers where the information is being requested. lineText : `string` - The text of the line where the information is being requested. names : `string list` - The identifiers at the location where the information is being requested. Returns: `FSharpSymbolUse option`	Resolve the names at the given location to a use of symbol. line : `int` The line number where the information is being requested. colAtEndOfNames : `int` The column number at the end of the identifiers where the information is being requested. lineText : `string` The text of the line where the information is being requested. names : `string list` The identifiers at the location where the information is being requested. Returns: `FSharpSymbolUse option`
`this.GetSymbolUsesAtLocation` Full Usage: `this.GetSymbolUsesAtLocation` Parameters: line : `int` - The line number where the information is being requested. colAtEndOfNames : `int` - The column number at the end of the identifiers where the information is being requested. lineText : `string` - The text of the line where the information is being requested. names : `string list` - The identifiers at the location where the information is being requested. Returns: `FSharpSymbolUse list`	Similar to GetSymbolUseAtLocation, but returns all found symbols if there are multiple. line : `int` The line number where the information is being requested. colAtEndOfNames : `int` The column number at the end of the identifiers where the information is being requested. lineText : `string` The text of the line where the information is being requested. names : `string list` The identifiers at the location where the information is being requested. Returns: `FSharpSymbolUse list`
`this.GetToolTip` Full Usage: `this.GetToolTip` Parameters: line : `int` - The line number where the information is being requested. colAtEndOfNames : `int` - The column number at the end of the identifiers where the information is being requested. lineText : `string` - The text of the line where the information is being requested. names : `string list` - The identifiers at the location where the information is being requested. tokenTag : `int` - Used to discriminate between 'identifiers', 'strings' and others. For strings, an attempt is made to give a tooltip for a #r "..." location. Use a value from FSharpTokenInfo.Tag, or FSharpTokenTag.Identifier, unless you have other information available. ?width : `int` - The optional width that the layout gets squashed to. Returns: `ToolTipText`	Compute a formatted tooltip for the given location line : `int` The line number where the information is being requested. colAtEndOfNames : `int` The column number at the end of the identifiers where the information is being requested. lineText : `string` The text of the line where the information is being requested. names : `string list` The identifiers at the location where the information is being requested. tokenTag : `int` Used to discriminate between 'identifiers', 'strings' and others. For strings, an attempt is made to give a tooltip for a #r "..." location. Use a value from FSharpTokenInfo.Tag, or FSharpTokenTag.Identifier, unless you have other information available. ?width : `int` The optional width that the layout gets squashed to. Returns: `ToolTipText`
`this.GetUsesOfSymbolInFile` Full Usage: `this.GetUsesOfSymbolInFile` Parameters: symbol : `FSharpSymbol` ?cancellationToken : `CancellationToken` Returns: `FSharpSymbolUse[]`	Get the textual usages that resolved to the given symbol throughout the file symbol : `FSharpSymbol` ?cancellationToken : `CancellationToken` Returns: `FSharpSymbolUse[]`
`this.HasFullTypeCheckInfo` Full Usage: `this.HasFullTypeCheckInfo` Returns: `bool`	Indicates whether type checking successfully occurred with some results returned. If false, indicates that an unrecoverable error in earlier checking/parsing/resolution steps. Returns: `bool`
`this.ImplementationFile` Full Usage: `this.ImplementationFile` Returns: `FSharpImplementationFileContents option`	Represents complete typechecked implementation file, including its typechecked signatures if any. Returns: `FSharpImplementationFileContents option`
`this.IsRelativeNameResolvableFromSymbol` Full Usage: `this.IsRelativeNameResolvableFromSymbol` Parameters: cursorPos : `pos` plid : `string list` symbol : `FSharpSymbol` Returns: `bool`	Determines if a long ident is resolvable at a specific point. cursorPos : `pos` plid : `string list` symbol : `FSharpSymbol` Returns: `bool`
`this.OpenDeclarations` Full Usage: `this.OpenDeclarations` Returns: `FSharpOpenDeclaration[]`	Open declarations in the file, including auto open modules. Returns: `FSharpOpenDeclaration[]`
`this.PartialAssemblySignature` Full Usage: `this.PartialAssemblySignature` Returns: `FSharpAssemblySignature`	Get a view of the contents of the assembly up to and including the file just checked Returns: `FSharpAssemblySignature`
`this.ProjectContext` Full Usage: `this.ProjectContext` Returns: `FSharpProjectContext`	Get the resolution of the ProjectOptions Returns: `FSharpProjectContext`