SequencePoint Struct

Definition

public value class SequencePoint : IEquatable<System::Reflection::Metadata::SequencePoint>

public readonly struct SequencePoint : IEquatable<System.Reflection.Metadata.SequencePoint>

public struct SequencePoint : IEquatable<System.Reflection.Metadata.SequencePoint>

type SequencePoint = struct

Public Structure SequencePoint
Implements IEquatable(Of SequencePoint)

Inheritance

Object

ValueType

SequencePoint

Implements

IEquatable<SequencePoint>

Examples

This example shows how to read sequence points of the method defined by the metadata token and display its source line mappings:

public static void ReadSourceLineData(string pdbPath, int methodToken)
{
 // Determine method row number
 EntityHandle ehMethod = MetadataTokens.EntityHandle(methodToken);

 if (ehMethod.Kind != HandleKind.MethodDefinition)
 {
 Console.WriteLine($"Invalid token kind: {ehMethod.Kind}");
 return;
 }

 int rowNumber = MetadataTokens.GetRowNumber(ehMethod);

 // MethodDebugInformation table is indexed by same row numbers as MethodDefinition table
 MethodDebugInformationHandle hDebug = MetadataTokens.MethodDebugInformationHandle(rowNumber);

 // Open Portable PDB file
 using var fs = new FileStream(pdbPath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
 using MetadataReaderProvider provider = MetadataReaderProvider.FromPortablePdbStream(fs);
 MetadataReader reader = provider.GetMetadataReader();

 if (rowNumber > reader.MethodDebugInformation.Count)
 {
 Console.WriteLine("Error: Method row number is out of range");
 return;
 }

 // Print source line information as console table
 MethodDebugInformation di = reader.GetMethodDebugInformation(hDebug);
 Console.WriteLine("IL offset | Start line | Start col. | End line | End col. |");

 foreach (SequencePoint sp in di.GetSequencePoints())
 {
 if (sp.IsHidden)
 {
 Console.WriteLine($"{sp.Offset.ToString().PadLeft(9)} | (hidden sequence point)");
 }
 else
 {
 Console.WriteLine("{0} |{1} |{2} |{3} |{4} |", 
 sp.Offset.ToString().PadLeft(9), 
 sp.StartLine.ToString().PadLeft(11),
 sp.StartColumn.ToString().PadLeft(11),
 sp.EndLine.ToString().PadLeft(9),
 sp.EndColumn.ToString().PadLeft(9));
 }
 }
}

Remarks

Sequence point is a structure that contains the mapping between IL offset and corresponding line and column numbers in a source document this IL was compiled from. Sequence points are stored in the MethodDebugInformation table of Portable PDB debugging symbols. For more information, see Portable PDB v1.0: Format Specification.