DiagnosticTools.SymbolPosition Method

Definition

Returns the zero-based line and character index indicating the position of a symbol in the file.

public static Microsoft.Quantum.QsCompiler.DataTypes.Position SymbolPosition (Microsoft.Quantum.QsCompiler.SyntaxTree.QsLocation rootLocation, Microsoft.Quantum.QsCompiler.DataTypes.QsNullable<Microsoft.Quantum.QsCompiler.DataTypes.Position> symbolPosition, Microsoft.Quantum.QsCompiler.DataTypes.Range symbolRange);
static member SymbolPosition : Microsoft.Quantum.QsCompiler.SyntaxTree.QsLocation * Microsoft.Quantum.QsCompiler.DataTypes.QsNullable<Microsoft.Quantum.QsCompiler.DataTypes.Position> * Microsoft.Quantum.QsCompiler.DataTypes.Range -> Microsoft.Quantum.QsCompiler.DataTypes.Position
Public Function SymbolPosition (rootLocation As QsLocation, symbolPosition As QsNullable(Of Position), symbolRange As Range) As Position

Parameters

rootLocation
QsLocation

The location information for a declared symbol.

symbolPosition
QsNullable<Position>

The position of the declaration within which the symbol is declared.

symbolRange
Range

Returns

Position

The line and character index, or null if the given object is not compatible with the position information generated by this Microsoft.Quantum.QsCompiler.CompilationBuilder.

Applies to